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

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/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/azure_mgmt_web/top_level_domains.rb', line 25

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns reference to the WebSiteManagementClient.

Returns:

  • reference to the WebSiteManagementClient



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

def client
  @client
end

Instance Method Details

#get_get_top_level_domains(custom_headers = nil) ⇒ TopLevelDomainCollection

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:



40
41
42
43
 
# File 'lib/azure_mgmt_web/top_level_domains.rb', line 40

def get_get_top_level_domains(custom_headers = nil)
  response = get_get_top_level_domains_async(custom_headers).value!
  response.body unless response.nil?
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.



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

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)
        unless parsed_response.nil?
          parsed_response = TopLevelDomainCollection.deserialize_object(parsed_response)
        end
        result.body = 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_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.



53
54
55
 
# File 'lib/azure_mgmt_web/top_level_domains.rb', line 53

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:



127
128
129
130
 
# File 'lib/azure_mgmt_web/top_level_domains.rb', line 127

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.



154
155
156
157
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
 
# File 'lib/azure_mgmt_web/top_level_domains.rb', line 154

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)
        unless parsed_response.nil?
          parsed_response = TopLevelDomain.deserialize_object(parsed_response)
        end
        result.body = 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_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.



141
142
143
 
# File 'lib/azure_mgmt_web/top_level_domains.rb', line 141

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) ⇒ TldLegalAgreementCollection

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:



219
220
221
222
 
# File 'lib/azure_mgmt_web/top_level_domains.rb', line 219

def list_top_level_domain_agreements(name, agreement_option, custom_headers = nil)
  response = list_top_level_domain_agreements_async(name, agreement_option, custom_headers).value!
  response.body unless response.nil?
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.



250
251
252
253
254
255
256
257
258
259
260
261
262
263
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
 
# File 'lib/azure_mgmt_web/top_level_domains.rb', line 250

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?
  agreement_option.validate unless 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?

  # Serialize Request
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  unless agreement_option.nil?
    agreement_option = TopLevelDomainAgreementOption.serialize_object(agreement_option)
  end
  request_content = agreement_option != nil ? JSON.generate(agreement_option, 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)
        unless parsed_response.nil?
          parsed_response = TldLegalAgreementCollection.deserialize_object(parsed_response)
        end
        result.body = 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_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.



235
236
237
 
# File 'lib/azure_mgmt_web/top_level_domains.rb', line 235

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