Class: Azure::Web::Mgmt::V2018_02_01::TopLevelDomains

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb

Overview

WebSite Management Client

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.



17
18
19
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientWebSiteManagementClient (readonly)

Returns reference to the WebSiteManagementClient.

Returns:



22
23
24
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 22

def client
  @client
end

Instance Method Details

#get(name, custom_headers: nil) ⇒ TopLevelDomain

Get details of a top-level domain.

Get 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:

  • (TopLevelDomain)

    operation results.



127
128
129
130
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 127

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

#get_async(name, custom_headers: nil) ⇒ Concurrent::Promise

Get details of a top-level domain.

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



158
159
160
161
162
163
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
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 158

def get_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 = {}
  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}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}'

  request_url = @base_url || @client.base_url

  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 || {}),
      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?
    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::Web::Mgmt::V2018_02_01::Models::TopLevelDomain.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(name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get details of a top-level domain.

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



143
144
145
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 143

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

#list(custom_headers: nil) ⇒ Array<TopLevelDomain>

Get all top-level domains supported for registration.

Get 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:

  • (Array<TopLevelDomain>)

    operation results.



34
35
36
37
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 34

def list(custom_headers:nil)
  first_page = list_as_lazy(custom_headers:custom_headers)
  first_page.get_all_items
end

#list_agreements(name, agreement_option, custom_headers: nil) ⇒ Array<TldLegalAgreement>

Gets all legal agreements that user needs to accept before purchasing a domain.

Gets all legal agreements that user needs to accept before purchasing a 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:

  • (Array<TldLegalAgreement>)

    operation results.



227
228
229
230
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 227

def list_agreements(name, agreement_option, custom_headers:nil)
  first_page = list_agreements_as_lazy(name, agreement_option, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_agreements_as_lazy(name, agreement_option, custom_headers: nil) ⇒ TldLegalAgreementCollection

Gets all legal agreements that user needs to accept before purchasing a domain.

Gets all legal agreements that user needs to accept before purchasing a 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:

  • (TldLegalAgreementCollection)

    which provide lazy access to pages of



564
565
566
567
568
569
570
571
572
573
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 564

def list_agreements_as_lazy(name, agreement_option, custom_headers:nil)
  response = list_agreements_async(name, agreement_option, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_agreements_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Gets all legal agreements that user needs to accept before purchasing a domain.

Gets all legal agreements that user needs to accept before purchasing a 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.



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
326
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 266

def list_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 = {}
  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::Web::Mgmt::V2018_02_01::Models::TopLevelDomainAgreementOption.mapper()
  request_content = @client.serialize(request_mapper,  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'

  request_url = @base_url || @client.base_url

  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 || {}),
      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?
    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::Web::Mgmt::V2018_02_01::Models::TldLegalAgreementCollection.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_agreements_next(next_page_link, custom_headers: nil) ⇒ TldLegalAgreementCollection

Gets all legal agreements that user needs to accept before purchasing a domain.

Gets all legal agreements that user needs to accept before purchasing a domain.

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:

  • (TldLegalAgreementCollection)

    operation results.



438
439
440
441
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 438

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

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

Gets all legal agreements that user needs to accept before purchasing a domain.

Gets all legal agreements that user needs to accept before purchasing a domain.

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.



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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 475

def list_agreements_next_async(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(: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?
    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::Web::Mgmt::V2018_02_01::Models::TldLegalAgreementCollection.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_agreements_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all legal agreements that user needs to accept before purchasing a domain.

Gets all legal agreements that user needs to accept before purchasing a domain.

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.



457
458
459
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 457

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

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

Gets all legal agreements that user needs to accept before purchasing a domain.

Gets all legal agreements that user needs to accept before purchasing a 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.



247
248
249
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 247

def list_agreements_with_http_info(name, agreement_option, custom_headers:nil)
  list_agreements_async(name, agreement_option, custom_headers:custom_headers).value!
end

#list_as_lazy(custom_headers: nil) ⇒ TopLevelDomainCollection

Get all top-level domains supported for registration.

Get 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:

  • (TopLevelDomainCollection)

    which provide lazy access to pages of the



537
538
539
540
541
542
543
544
545
546
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 537

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

#list_async(custom_headers: nil) ⇒ Concurrent::Promise

Get all top-level domains supported for registration.

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



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
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 63

def list_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 = {}
  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}/providers/Microsoft.DomainRegistration/topLevelDomains'

  request_url = @base_url || @client.base_url

  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 || {}),
      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?
    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::Web::Mgmt::V2018_02_01::Models::TopLevelDomainCollection.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_next(next_page_link, custom_headers: nil) ⇒ TopLevelDomainCollection

Get all top-level domains supported for registration.

Get all top-level domains supported for registration.

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:

  • (TopLevelDomainCollection)

    operation results.



340
341
342
343
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 340

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

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

Get all top-level domains supported for registration.

Get all top-level domains supported for registration.

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.



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
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 373

def list_next_async(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?
    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::Web::Mgmt::V2018_02_01::Models::TopLevelDomainCollection.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get all top-level domains supported for registration.

Get all top-level domains supported for registration.

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.



357
358
359
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 357

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

#list_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get all top-level domains supported for registration.

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



49
50
51
# File 'lib/2018-02-01/generated/azure_mgmt_web/top_level_domains.rb', line 49

def list_with_http_info(custom_headers:nil)
  list_async(custom_headers:custom_headers).value!
end