Class: Azure::ARM::Web::TopLevelDomains

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/top_level_domains.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) ⇒ TopLevelDomains

Creates and initializes a new instance of the TopLevelDomains class.

Parameters:

  • client —

    service class for accessing basic functionality.



25
26
27
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.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/top_level_domains.rb', line 30

def client
  @client
end

Instance Method Details

#get_get_top_level_domains(custom_headers = nil) ⇒ Array<TopLevelDomain>

Lists all top level domains supported for registration

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/top_level_domains.rb', line 60

def get_get_top_level_domains(custom_headers = nil)
  first_page = get_get_top_level_domains_as_lazy(custom_headers)
  first_page.get_all_items
end

#get_get_top_level_domains_as_lazy(custom_headers = nil) ⇒ TopLevelDomainCollection

Lists all top level domains supported for registration

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/top_level_domains.rb', line 41

def get_get_top_level_domains_as_lazy(custom_headers = nil)
  response = get_get_top_level_domains_async(custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_link|
      get_get_top_level_domains_next_async(next_link, custom_headers)
    end
    page
  end
end

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

Lists all top level domains supported for registration

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

def get_get_top_level_domains_async(custom_headers = 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 = {}

  # 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}/providers/Microsoft.DomainRegistration/topLevelDomains'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      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 = TopLevelDomainCollection.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_get_top_level_domains_next(next_page_link, custom_headers = nil) ⇒ TopLevelDomainCollection

Lists all top level domains supported for registration

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:



367
368
369
370
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 367

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

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

Lists all top level domains supported for registration

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.



396
397
398
399
400
401
402
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
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 396

def get_get_top_level_domains_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 = TopLevelDomainCollection.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_get_top_level_domains_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all top level domains supported for registration

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.



382
383
384
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 382

def get_get_top_level_domains_next_with_http_info(next_page_link, custom_headers = nil)
  get_get_top_level_domains_next_async(next_page_link, custom_headers).value!
end

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

Lists all top level domains supported for registration

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/top_level_domains.rb', line 73

def get_get_top_level_domains_with_http_info(custom_headers = nil)
  get_get_top_level_domains_async(custom_headers).value!
end

#get_top_level_domain(name, custom_headers = nil) ⇒ TopLevelDomain

Gets details of a top level domain

will be added to the HTTP request.

Parameters:

  • name (String) —

    Name of the top level domain

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

    A hash of custom headers that

Returns:



147
148
149
150
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 147

def get_top_level_domain(name, custom_headers = nil)
  response = get_top_level_domain_async(name, custom_headers).value!
  response.body unless response.nil?
end

#get_top_level_domain_async(name, custom_headers = nil) ⇒ Concurrent::Promise

Gets details of a top level domain

to the HTTP request.

Parameters:

  • name (String) —

    Name of the top level domain

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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/generated/azure_mgmt_web/top_level_domains.rb', line 174

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


  request_headers = {}

  # 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}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'name' => name,'subscriptionId' => @client.subscription_id},
      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 = TopLevelDomain.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_top_level_domain_with_http_info(name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets details of a top level domain

will be added to the HTTP request.

Parameters:

  • name (String) —

    Name of the top level domain

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



161
162
163
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 161

def get_top_level_domain_with_http_info(name, custom_headers = nil)
  get_top_level_domain_async(name, custom_headers).value!
end

#list_top_level_domain_agreements(name, agreement_option, custom_headers = nil) ⇒ Array<TldLegalAgreement>

Lists legal agreements that user needs to accept before purchasing domain

options will be added to the HTTP request.

Parameters:

  • name (String) —

    Name of the top level domain

  • agreement_option (TopLevelDomainAgreementOption) —

    Domain agreement

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

    A hash of custom headers that

Returns:



262
263
264
265
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 262

def list_top_level_domain_agreements(name, agreement_option, custom_headers = nil)
  first_page = list_top_level_domain_agreements_as_lazy(name, agreement_option, custom_headers)
  first_page.get_all_items
end

#list_top_level_domain_agreements_as_lazy(name, agreement_option, custom_headers = nil) ⇒ TldLegalAgreementCollection

Lists legal agreements that user needs to accept before purchasing domain

options will be added to the HTTP request.

the response.

Parameters:

  • name (String) —

    Name of the top level domain

  • agreement_option (TopLevelDomainAgreementOption) —

    Domain agreement

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

    A hash of custom headers that

Returns:



240
241
242
243
244
245
246
247
248
249
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 240

def list_top_level_domain_agreements_as_lazy(name, agreement_option, custom_headers = nil)
  response = list_top_level_domain_agreements_async(name, agreement_option, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_link|
      list_top_level_domain_agreements_next_async(next_link, custom_headers)
    end
    page
  end
end

#list_top_level_domain_agreements_async(name, agreement_option, custom_headers = nil) ⇒ Concurrent::Promise

Lists legal agreements that user needs to accept before purchasing domain

options to the HTTP request.

Parameters:

  • name (String) —

    Name of the top level domain

  • agreement_option (TopLevelDomainAgreementOption) —

    Domain agreement

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
354
355
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 293

def list_top_level_domain_agreements_async(name, agreement_option, custom_headers = nil)
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, 'agreement_option is nil' if agreement_option.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 = {}

  # 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 = TopLevelDomainAgreementOption.mapper()
  request_content = @client.serialize(request_mapper,  agreement_option, 'agreement_option')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'name' => name,'subscriptionId' => @client.subscription_id},
      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, :post, 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 = TldLegalAgreementCollection.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

#list_top_level_domain_agreements_next(next_page_link, custom_headers = nil) ⇒ TldLegalAgreementCollection

Lists legal agreements that user needs to accept before purchasing domain

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:



457
458
459
460
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 457

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

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

Lists legal agreements that user needs to accept before purchasing domain

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.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
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
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 486

def list_top_level_domain_agreements_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, :post, 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 = TldLegalAgreementCollection.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

#list_top_level_domain_agreements_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists legal agreements that user needs to accept before purchasing domain

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.



472
473
474
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 472

def list_top_level_domain_agreements_next_with_http_info(next_page_link, custom_headers = nil)
  list_top_level_domain_agreements_next_async(next_page_link, custom_headers).value!
end

#list_top_level_domain_agreements_with_http_info(name, agreement_option, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists legal agreements that user needs to accept before purchasing domain

options will be added to the HTTP request.

Parameters:

  • name (String) —

    Name of the top level domain

  • agreement_option (TopLevelDomainAgreementOption) —

    Domain agreement

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



278
279
280
 
# File 'lib/generated/azure_mgmt_web/top_level_domains.rb', line 278

def list_top_level_domain_agreements_with_http_info(name, agreement_option, custom_headers = nil)
  list_top_level_domain_agreements_async(name, agreement_option, custom_headers).value!
end