Class: Azure::ARM::Web::Domains

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

Creates and initializes a new instance of the Domains class.

Parameters:

  • client

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientObject (readonly)

Returns reference to the WebSiteManagementClient.

Returns:

  • reference to the WebSiteManagementClient



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

def client
  @client
end

Instance Method Details

#create_or_update_domain(resource_group_name, domain_name, domain, custom_headers = nil) ⇒ Domain

Creates a domain

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    &gt;Name of the resource group

  • domain_name (String)

    Name of the domain

  • domain (Domain)

    Domain registration information

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

    A hash of custom headers that

Returns:

  • (Domain)

    operation results.



227
228
229
230
# File 'lib/generated/azure_mgmt_web/domains.rb', line 227

def create_or_update_domain(resource_group_name, domain_name, domain, custom_headers = nil)
  response = create_or_update_domain_async(resource_group_name, domain_name, domain, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_domain_async(resource_group_name, domain_name, domain, custom_headers = nil) ⇒ Concurrent::Promise

Creates a domain

to the HTTP request.

Parameters:

  • resource_group_name (String)

    &gt;Name of the resource group

  • domain_name (String)

    Name of the domain

  • domain (Domain)

    Domain registration information

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/generated/azure_mgmt_web/domains.rb', line 258

def create_or_update_domain_async(resource_group_name, domain_name, domain, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'domain_name is nil' if domain_name.nil?
  fail ArgumentError, 'domain is nil' if domain.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 = Domain.mapper()
  request_content = @client.serialize(request_mapper,  domain, 'domain')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'domainName' => domain_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, :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 == 202 || 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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Domain.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
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Domain.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

#create_or_update_domain_with_http_info(resource_group_name, domain_name, domain, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a domain

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    &gt;Name of the resource group

  • domain_name (String)

    Name of the domain

  • domain (Domain)

    Domain registration information

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



243
244
245
# File 'lib/generated/azure_mgmt_web/domains.rb', line 243

def create_or_update_domain_with_http_info(resource_group_name, domain_name, domain, custom_headers = nil)
  create_or_update_domain_async(resource_group_name, domain_name, domain, custom_headers).value!
end

#delete_domain(resource_group_name, domain_name, force_hard_delete_domain = nil, custom_headers = nil) ⇒ Object

Deletes a domain

deleted immediately instead of after 24 hours will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • domain_name (String)

    Name of the domain

  • force_hard_delete_domain (Boolean) (defaults to: nil)

    If true then the domain will be

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

    A hash of custom headers that

Returns:

  • (Object)

    operation results.



345
346
347
348
# File 'lib/generated/azure_mgmt_web/domains.rb', line 345

def delete_domain(resource_group_name, domain_name, force_hard_delete_domain = nil, custom_headers = nil)
  response = delete_domain_async(resource_group_name, domain_name, force_hard_delete_domain, custom_headers).value!
  response.body unless response.nil?
end

#delete_domain_async(resource_group_name, domain_name, force_hard_delete_domain = nil, custom_headers = nil) ⇒ Concurrent::Promise

Deletes a domain

deleted immediately instead of after 24 hours to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • domain_name (String)

    Name of the domain

  • force_hard_delete_domain (Boolean) (defaults to: nil)

    If true then the domain will be

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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

def delete_domain_async(resource_group_name, domain_name, force_hard_delete_domain = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'domain_name is nil' if domain_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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'domainName' => domain_name,'subscriptionId' => @client.subscription_id},
      query_params: {'forceHardDeleteDomain' => force_hard_delete_domain,'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, :delete, 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 == 204
      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?

    result
  end

  promise.execute
end

#delete_domain_with_http_info(resource_group_name, domain_name, force_hard_delete_domain = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a domain

deleted immediately instead of after 24 hours will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • domain_name (String)

    Name of the domain

  • force_hard_delete_domain (Boolean) (defaults to: nil)

    If true then the domain will be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



362
363
364
# File 'lib/generated/azure_mgmt_web/domains.rb', line 362

def delete_domain_with_http_info(resource_group_name, domain_name, force_hard_delete_domain = nil, custom_headers = nil)
  delete_domain_async(resource_group_name, domain_name, force_hard_delete_domain, custom_headers).value!
end

#get_domain(resource_group_name, domain_name, custom_headers = nil) ⇒ Domain

Gets details of a domain

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • domain_name (String)

    Name of the domain

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

    A hash of custom headers that

Returns:

  • (Domain)

    operation results.



132
133
134
135
# File 'lib/generated/azure_mgmt_web/domains.rb', line 132

def get_domain(resource_group_name, domain_name, custom_headers = nil)
  response = get_domain_async(resource_group_name, domain_name, custom_headers).value!
  response.body unless response.nil?
end

#get_domain_async(resource_group_name, domain_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets details of a domain

to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • domain_name (String)

    Name of the domain

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
211
212
213
214
# File 'lib/generated/azure_mgmt_web/domains.rb', line 161

def get_domain_async(resource_group_name, domain_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'domain_name is nil' if domain_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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'domainName' => domain_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 = Domain.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_domain_operation(resource_group_name, domain_name, operation_id, custom_headers = nil) ⇒ Domain

Retrieves the latest status of a domain purchase operation

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • domain_name (String)

    Name of the domain

  • operation_id (String)

    Domain purchase operation Id

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

    A hash of custom headers that

Returns:

  • (Domain)

    operation results.



551
552
553
554
# File 'lib/generated/azure_mgmt_web/domains.rb', line 551

def get_domain_operation(resource_group_name, domain_name, operation_id, custom_headers = nil)
  response = get_domain_operation_async(resource_group_name, domain_name, operation_id, custom_headers).value!
  response.body unless response.nil?
end

#get_domain_operation_async(resource_group_name, domain_name, operation_id, custom_headers = nil) ⇒ Concurrent::Promise

Retrieves the latest status of a domain purchase operation

to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • domain_name (String)

    Name of the domain

  • operation_id (String)

    Domain purchase operation Id

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'lib/generated/azure_mgmt_web/domains.rb', line 582

def get_domain_operation_async(resource_group_name, domain_name, operation_id, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'domain_name is nil' if domain_name.nil?
  fail ArgumentError, 'operation_id is nil' if operation_id.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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'domainName' => domain_name,'operationId' => operation_id,'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 == 202 || status_code == 200 || status_code == 500
      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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Domain.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
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Domain.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_domain_operation_with_http_info(resource_group_name, domain_name, operation_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the latest status of a domain purchase operation

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • domain_name (String)

    Name of the domain

  • operation_id (String)

    Domain purchase operation Id

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



567
568
569
# File 'lib/generated/azure_mgmt_web/domains.rb', line 567

def get_domain_operation_with_http_info(resource_group_name, domain_name, operation_id, custom_headers = nil)
  get_domain_operation_async(resource_group_name, domain_name, operation_id, custom_headers).value!
end

#get_domain_with_http_info(resource_group_name, domain_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets details of a domain

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • domain_name (String)

    Name of the domain

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



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

def get_domain_with_http_info(resource_group_name, domain_name, custom_headers = nil)
  get_domain_async(resource_group_name, domain_name, custom_headers).value!
end

#get_domains(resource_group_name, custom_headers = nil) ⇒ DomainCollection

Lists domains under a resource group

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

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

    A hash of custom headers that

Returns:



41
42
43
44
# File 'lib/generated/azure_mgmt_web/domains.rb', line 41

def get_domains(resource_group_name, custom_headers = nil)
  response = get_domains_async(resource_group_name, custom_headers).value!
  response.body unless response.nil?
end

#get_domains_async(resource_group_name, custom_headers = nil) ⇒ Concurrent::Promise

Lists domains under a resource group

to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
117
118
119
120
# File 'lib/generated/azure_mgmt_web/domains.rb', line 68

def get_domains_async(resource_group_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_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 = DomainCollection.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_domains_with_http_info(resource_group_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists domains under a resource group

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



55
56
57
# File 'lib/generated/azure_mgmt_web/domains.rb', line 55

def get_domains_with_http_info(resource_group_name, custom_headers = nil)
  get_domains_async(resource_group_name, custom_headers).value!
end

#update_domain(resource_group_name, domain_name, domain, custom_headers = nil) ⇒ Domain

Creates a domain

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    &gt;Name of the resource group

  • domain_name (String)

    Name of the domain

  • domain (Domain)

    Domain registration information

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

    A hash of custom headers that

Returns:

  • (Domain)

    operation results.



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

def update_domain(resource_group_name, domain_name, domain, custom_headers = nil)
  response = update_domain_async(resource_group_name, domain_name, domain, custom_headers).value!
  response.body unless response.nil?
end

#update_domain_async(resource_group_name, domain_name, domain, custom_headers = nil) ⇒ Concurrent::Promise

Creates a domain

to the HTTP request.

Parameters:

  • resource_group_name (String)

    &gt;Name of the resource group

  • domain_name (String)

    Name of the domain

  • domain (Domain)

    Domain registration information

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
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
536
537
538
# File 'lib/generated/azure_mgmt_web/domains.rb', line 465

def update_domain_async(resource_group_name, domain_name, domain, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'domain_name is nil' if domain_name.nil?
  fail ArgumentError, 'domain is nil' if domain.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 = Domain.mapper()
  request_content = @client.serialize(request_mapper,  domain, 'domain')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'domainName' => domain_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, :patch, 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 == 202 || 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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Domain.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
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Domain.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_domain_with_http_info(resource_group_name, domain_name, domain, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a domain

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    &gt;Name of the resource group

  • domain_name (String)

    Name of the domain

  • domain (Domain)

    Domain registration information

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



450
451
452
# File 'lib/generated/azure_mgmt_web/domains.rb', line 450

def update_domain_with_http_info(resource_group_name, domain_name, domain, custom_headers = nil)
  update_domain_async(resource_group_name, domain_name, domain, custom_headers).value!
end