Class: Azure::ARM::Web::Provider

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/provider.rb

Overview

Use these APIs to manage Azure Websites resources through the Azure Resource Manager. All task operations conform to the HTTP/1.1 protocol specification and each operation returns an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure. For more information, see <a href=“msdn.microsoft.com/en-us/library/azure/dn790557.aspx”>Authenticating Azure Resource Manager requests.</a>

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Provider

Creates and initializes a new instance of the Provider class.

Parameters:

  • client —

    service class for accessing basic functionality.



25
26
27
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 25

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ WebSiteManagementClient (readonly)

Returns reference to the WebSiteManagementClient.

Returns:



30
31
32
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 30

def client
  @client
end

Instance Method Details

#get_publishing_user(custom_headers = nil) ⇒ User

Gets publishing user

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (User) —

    operation results.



335
336
337
338
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 335

def get_publishing_user(custom_headers = nil)
  response = get_publishing_user_async(custom_headers).value!
  response.body unless response.nil?
end

#get_publishing_user_async(custom_headers = nil) ⇒ Concurrent::Promise

Gets publishing user

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.



360
361
362
363
364
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
406
407
408
409
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 360

def get_publishing_user_async(custom_headers = nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # 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 = '/providers/Microsoft.Web/publishingUsers/web'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = User.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_publishing_user_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets publishing user

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.



348
349
350
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 348

def get_publishing_user_with_http_info(custom_headers = nil)
  get_publishing_user_async(custom_headers).value!
end

#get_source_control(source_control_type, custom_headers = nil) ⇒ SourceControl

Gets source control token

will be added to the HTTP request.

Parameters:

  • source_control_type (String) —

    Type of source control

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

    A hash of custom headers that

Returns:



145
146
147
148
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 145

def get_source_control(source_control_type, custom_headers = nil)
  response = get_source_control_async(source_control_type, custom_headers).value!
  response.body unless response.nil?
end

#get_source_control_async(source_control_type, custom_headers = nil) ⇒ Concurrent::Promise

Gets source control token

to the HTTP request.

Parameters:

  • source_control_type (String) —

    Type of source control

  • 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
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 172

def get_source_control_async(source_control_type, custom_headers = nil)
  fail ArgumentError, 'source_control_type is nil' if source_control_type.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # 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 = '/providers/Microsoft.Web/sourcecontrols/{sourceControlType}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'sourceControlType' => source_control_type},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = SourceControl.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_source_control_with_http_info(source_control_type, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets source control token

will be added to the HTTP request.

Parameters:

  • source_control_type (String) —

    Type of source control

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



159
160
161
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 159

def get_source_control_with_http_info(source_control_type, custom_headers = nil)
  get_source_control_async(source_control_type, custom_headers).value!
end

#get_source_controls(custom_headers = nil) ⇒ Array<SourceControl>

Gets the source controls available for Azure websites

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:



60
61
62
63
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 60

def get_source_controls(custom_headers = nil)
  first_page = get_source_controls_as_lazy(custom_headers)
  first_page.get_all_items
end

#get_source_controls_as_lazy(custom_headers = nil) ⇒ SourceControlCollection

Gets the source controls available for Azure websites

will be added to the HTTP request.

response.

Parameters:

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

    A hash of custom headers that

Returns:



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 41

def get_source_controls_as_lazy(custom_headers = nil)
  response = get_source_controls_async(custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_link|
      get_source_controls_next_async(next_link, custom_headers)
    end
    page
  end
end

#get_source_controls_async(custom_headers = nil) ⇒ Concurrent::Promise

Gets the source controls available for Azure websites

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.



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
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 85

def get_source_controls_async(custom_headers = nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # 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 = '/providers/Microsoft.Web/sourcecontrols'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = SourceControlCollection.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_source_controls_next(next_page_link, custom_headers = nil) ⇒ SourceControlCollection

Gets the source controls available for Azure websites

call to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



518
519
520
521
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 518

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

#get_source_controls_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Gets the source controls available for Azure websites

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 547

def get_source_controls_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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = SourceControlCollection.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_source_controls_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the source controls available for Azure websites

call to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



533
534
535
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 533

def get_source_controls_next_with_http_info(next_page_link, custom_headers = nil)
  get_source_controls_next_async(next_page_link, custom_headers).value!
end

#get_source_controls_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the source controls available for Azure websites

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.



73
74
75
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 73

def get_source_controls_with_http_info(custom_headers = nil)
  get_source_controls_async(custom_headers).value!
end

#update_publishing_user(request_message, custom_headers = nil) ⇒ User

Updates publishing user

will be added to the HTTP request.

Parameters:

  • request_message (User) —

    Details of publishing user

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

    A hash of custom headers that

Returns:

  • (User) —

    operation results.



420
421
422
423
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 420

def update_publishing_user(request_message, custom_headers = nil)
  response = update_publishing_user_async(request_message, custom_headers).value!
  response.body unless response.nil?
end

#update_publishing_user_async(request_message, custom_headers = nil) ⇒ Concurrent::Promise

Updates publishing user

to the HTTP request.

Parameters:

  • request_message (User) —

    Details of publishing user

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 447

def update_publishing_user_async(request_message, custom_headers = nil)
  fail ArgumentError, 'request_message is nil' if request_message.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = User.mapper()
  request_content = @client.serialize(request_mapper,  request_message, 'request_message')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/providers/Microsoft.Web/publishingUsers/web'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :put, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = User.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_publishing_user_with_http_info(request_message, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Updates publishing user

will be added to the HTTP request.

Parameters:

  • request_message (User) —

    Details of publishing user

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



434
435
436
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 434

def update_publishing_user_with_http_info(request_message, custom_headers = nil)
  update_publishing_user_async(request_message, custom_headers).value!
end

#update_source_control(source_control_type, request_message, custom_headers = nil) ⇒ SourceControl

Updates source control token

will be added to the HTTP request.

Parameters:

  • source_control_type (String) —

    Type of source control

  • request_message (SourceControl) —

    Source control token information

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

    A hash of custom headers that

Returns:



235
236
237
238
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 235

def update_source_control(source_control_type, request_message, custom_headers = nil)
  response = update_source_control_async(source_control_type, request_message, custom_headers).value!
  response.body unless response.nil?
end

#update_source_control_async(source_control_type, request_message, custom_headers = nil) ⇒ Concurrent::Promise

Updates source control token

to the HTTP request.

Parameters:

  • source_control_type (String) —

    Type of source control

  • request_message (SourceControl) —

    Source control token information

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



264
265
266
267
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
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 264

def update_source_control_async(source_control_type, request_message, custom_headers = nil)
  fail ArgumentError, 'source_control_type is nil' if source_control_type.nil?
  fail ArgumentError, 'request_message is nil' if request_message.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = SourceControl.mapper()
  request_content = @client.serialize(request_mapper,  request_message, 'request_message')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/providers/Microsoft.Web/sourcecontrols/{sourceControlType}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'sourceControlType' => source_control_type},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :put, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = SourceControl.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_source_control_with_http_info(source_control_type, request_message, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Updates source control token

will be added to the HTTP request.

Parameters:

  • source_control_type (String) —

    Type of source control

  • request_message (SourceControl) —

    Source control token information

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



250
251
252
 
# File 'lib/generated/azure_mgmt_web/provider.rb', line 250

def update_source_control_with_http_info(source_control_type, request_message, custom_headers = nil)
  update_source_control_async(source_control_type, request_message, custom_headers).value!
end