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

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

Overview

WebSite Management Client

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.



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

def client
  @client
end

Instance Method Details

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

Creates or updates a domain.

Creates or updates a domain.

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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



1314
1315
1316
1317
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1314

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

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

Creates or updates a domain.

Creates or updates a domain.

resource belongs. to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1351

def begin_create_or_update_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?
  api_version = '2015-04-01'


  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 = Azure::ARM::Web::Models::Domain.mapper()
  request_content = @client.serialize(request_mapper,  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}'

  request_url = @base_url || @client.base_url

  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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 == 202 || status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::Domain.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
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::Domain.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

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

Creates or updates a domain.

Creates or updates a domain.

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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



1333
1334
1335
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1333

def begin_create_or_update_with_http_info(resource_group_name, domain_name, domain, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, domain_name, domain, custom_headers).value!
end

#check_availability(identifier, custom_headers = nil) ⇒ DomainAvailablilityCheckResult

Check if a domain is available for registration.

Check if a domain is available for registration.

will be added to the HTTP request.

Parameters:

  • identifier (NameIdentifier)

    Name of the domain.

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

    A hash of custom headers that

Returns:

  • (DomainAvailablilityCheckResult)

    operation results.



35
36
37
38
# File 'lib/generated/azure_mgmt_web/domains.rb', line 35

def check_availability(identifier, custom_headers = nil)
  response = check_availability_async(identifier, custom_headers).value!
  response.body unless response.nil?
end

#check_availability_async(identifier, custom_headers = nil) ⇒ Concurrent::Promise

Check if a domain is available for registration.

Check if a domain is available for registration.

to the HTTP request.

Parameters:

  • identifier (NameIdentifier)

    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.



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

def check_availability_async(identifier, custom_headers = nil)
  fail ArgumentError, 'identifier is nil' if identifier.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  api_version = '2015-04-01'


  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 = Azure::ARM::Web::Models::NameIdentifier.mapper()
  request_content = @client.serialize(request_mapper,  identifier)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability'

  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' => 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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainAvailablilityCheckResult.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

#check_availability_with_http_info(identifier, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Check if a domain is available for registration.

Check if a domain is available for registration.

will be added to the HTTP request.

Parameters:

  • identifier (NameIdentifier)

    Name of the domain.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



51
52
53
# File 'lib/generated/azure_mgmt_web/domains.rb', line 51

def check_availability_with_http_info(identifier, custom_headers = nil)
  check_availability_async(identifier, custom_headers).value!
end

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

Creates or updates a domain.

Creates or updates a domain.

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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



619
620
621
622
# File 'lib/generated/azure_mgmt_web/domains.rb', line 619

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

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

resource belongs. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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

  • (Concurrent::Promise)

    promise which provides async access to http



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
# File 'lib/generated/azure_mgmt_web/domains.rb', line 635

def create_or_update_async(resource_group_name, domain_name, domain, custom_headers = nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, domain_name, domain, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ARM::Web::Models::Domain.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#create_or_update_ownership_identifier(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil) ⇒ DomainOwnershipIdentifier

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

resource belongs. representation of the domain ownership properties. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

  • domain_ownership_identifier (DomainOwnershipIdentifier)

    A JSON

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

    A hash of custom headers that

Returns:

  • (DomainOwnershipIdentifier)

    operation results.



973
974
975
976
# File 'lib/generated/azure_mgmt_web/domains.rb', line 973

def create_or_update_ownership_identifier(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil)
  response = create_or_update_ownership_identifier_async(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_ownership_identifier_async(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil) ⇒ Concurrent::Promise

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

resource belongs. representation of the domain ownership properties. to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

  • domain_ownership_identifier (DomainOwnershipIdentifier)

    A JSON

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1018

def create_or_update_ownership_identifier_async(resource_group_name, domain_name, name, domain_ownership_identifier, 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, 'name is nil' if name.nil?
  fail ArgumentError, 'domain_ownership_identifier is nil' if domain_ownership_identifier.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  api_version = '2015-04-01'


  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 = Azure::ARM::Web::Models::DomainOwnershipIdentifier.mapper()
  request_content = @client.serialize(request_mapper,  domain_ownership_identifier)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'domainName' => domain_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainOwnershipIdentifier.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

#create_or_update_ownership_identifier_with_http_info(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

resource belongs. representation of the domain ownership properties. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

  • domain_ownership_identifier (DomainOwnershipIdentifier)

    A JSON

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



996
997
998
# File 'lib/generated/azure_mgmt_web/domains.rb', line 996

def create_or_update_ownership_identifier_with_http_info(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil)
  create_or_update_ownership_identifier_async(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers).value!
end

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

Delete a domain.

Delete a domain.

resource belongs. the domain immediately. The default is false which deletes the domain after 24 hours. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of the domain.

  • force_hard_delete_domain (Boolean) (defaults to: nil)

    Specify true to delete

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

    A hash of custom headers that



668
669
670
671
# File 'lib/generated/azure_mgmt_web/domains.rb', line 668

def delete(resource_group_name, domain_name, force_hard_delete_domain = nil, custom_headers = nil)
  response = delete_async(resource_group_name, domain_name, force_hard_delete_domain, custom_headers).value!
  nil
end

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

Delete a domain.

Delete a domain.

resource belongs. the domain immediately. The default is false which deletes the domain after 24 hours. to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of the domain.

  • force_hard_delete_domain (Boolean) (defaults to: nil)

    Specify true to delete

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
# File 'lib/generated/azure_mgmt_web/domains.rb', line 709

def delete_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?
  api_version = '2015-04-01'


  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}'

  request_url = @base_url || @client.base_url

  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' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.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
  end

  promise.execute
end

#delete_ownership_identifier(resource_group_name, domain_name, name, custom_headers = nil) ⇒ Object

Delete ownership identifier for domain

Delete ownership identifier for domain

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

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

    A hash of custom headers that



1094
1095
1096
1097
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1094

def delete_ownership_identifier(resource_group_name, domain_name, name, custom_headers = nil)
  response = delete_ownership_identifier_async(resource_group_name, domain_name, name, custom_headers).value!
  nil
end

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

Delete ownership identifier for domain

Delete ownership identifier for domain

resource belongs. to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1131

def delete_ownership_identifier_async(resource_group_name, domain_name, 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, 'name is nil' if name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  api_version = '2015-04-01'


  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}/domainOwnershipIdentifiers/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'domainName' => domain_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.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
  end

  promise.execute
end

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

Delete ownership identifier for domain

Delete ownership identifier for domain

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1113
1114
1115
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1113

def delete_ownership_identifier_with_http_info(resource_group_name, domain_name, name, custom_headers = nil)
  delete_ownership_identifier_async(resource_group_name, domain_name, name, custom_headers).value!
end

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

Delete a domain.

Delete a domain.

resource belongs. the domain immediately. The default is false which deletes the domain after 24 hours. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of the domain.

  • force_hard_delete_domain (Boolean) (defaults to: nil)

    Specify true to delete

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



689
690
691
# File 'lib/generated/azure_mgmt_web/domains.rb', line 689

def delete_with_http_info(resource_group_name, domain_name, force_hard_delete_domain = nil, custom_headers = nil)
  delete_async(resource_group_name, domain_name, force_hard_delete_domain, custom_headers).value!
end

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

Get a domain.

Get a domain.

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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



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

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

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

Get a domain.

Get a domain.

resource belongs. to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
# File 'lib/generated/azure_mgmt_web/domains.rb', line 553

def get_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?
  api_version = '2015-04-01'


  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}'

  request_url = @base_url || @client.base_url

  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' => 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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::Domain.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_control_center_sso_request(custom_headers = nil) ⇒ DomainControlCenterSsoRequest

Generate a single sign-on request for the domain management portal.

Generate a single sign-on request for the domain management portal.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (DomainControlCenterSsoRequest)

    operation results.



225
226
227
228
# File 'lib/generated/azure_mgmt_web/domains.rb', line 225

def get_control_center_sso_request(custom_headers = nil)
  response = get_control_center_sso_request_async(custom_headers).value!
  response.body unless response.nil?
end

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

Generate a single sign-on request for the domain management portal.

Generate a single sign-on request for the domain management portal.

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.



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

def get_control_center_sso_request_async(custom_headers = nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  api_version = '2015-04-01'


  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/generateSsoRequest'

  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' => api_version},
      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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainControlCenterSsoRequest.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_control_center_sso_request_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Generate a single sign-on request for the domain management portal.

Generate a single sign-on request for the domain management portal.

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.



240
241
242
# File 'lib/generated/azure_mgmt_web/domains.rb', line 240

def get_control_center_sso_request_with_http_info(custom_headers = nil)
  get_control_center_sso_request_async(custom_headers).value!
end

#get_ownership_identifier(resource_group_name, domain_name, name, custom_headers = nil) ⇒ DomainOwnershipIdentifier

Get ownership identifier for domain

Get ownership identifier for domain

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

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

    A hash of custom headers that

Returns:

  • (DomainOwnershipIdentifier)

    operation results.



865
866
867
868
# File 'lib/generated/azure_mgmt_web/domains.rb', line 865

def get_ownership_identifier(resource_group_name, domain_name, name, custom_headers = nil)
  response = get_ownership_identifier_async(resource_group_name, domain_name, name, custom_headers).value!
  response.body unless response.nil?
end

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

Get ownership identifier for domain

Get ownership identifier for domain

resource belongs. to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'lib/generated/azure_mgmt_web/domains.rb', line 902

def get_ownership_identifier_async(resource_group_name, domain_name, 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, 'name is nil' if name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  api_version = '2015-04-01'


  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}/domainOwnershipIdentifiers/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'domainName' => domain_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => 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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainOwnershipIdentifier.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_ownership_identifier_with_http_info(resource_group_name, domain_name, name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get ownership identifier for domain

Get ownership identifier for domain

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



884
885
886
# File 'lib/generated/azure_mgmt_web/domains.rb', line 884

def get_ownership_identifier_with_http_info(resource_group_name, domain_name, name, custom_headers = nil)
  get_ownership_identifier_async(resource_group_name, domain_name, name, custom_headers).value!
end

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

Get a domain.

Get a domain.

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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



536
537
538
# File 'lib/generated/azure_mgmt_web/domains.rb', line 536

def get_with_http_info(resource_group_name, domain_name, custom_headers = nil)
  get_async(resource_group_name, domain_name, custom_headers).value!
end

#list(custom_headers = nil) ⇒ Array<Domain>

Get all domains in a subscription.

Get all domains in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<Domain>)

    operation results.



136
137
138
139
# File 'lib/generated/azure_mgmt_web/domains.rb', line 136

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

#list_as_lazy(custom_headers = nil) ⇒ DomainCollection

Get all domains in a subscription.

Get all domains in a subscription.

will be added to the HTTP request.

response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (DomainCollection)

    which provide lazy access to pages of the



1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1806

def list_as_lazy(custom_headers = nil)
  response = list_async(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)
    end
    page
  end
end

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

Get all domains in a subscription.

Get all domains in a subscription.

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.



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

def list_async(custom_headers = nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  api_version = '2015-04-01'


  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/domains'

  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' => 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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainCollection.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_by_resource_group(resource_group_name, custom_headers = nil) ⇒ Array<Domain>

Get all domains in a resource group.

Get all domains in a resource group.

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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

    A hash of custom headers that

Returns:

  • (Array<Domain>)

    operation results.



421
422
423
424
# File 'lib/generated/azure_mgmt_web/domains.rb', line 421

def list_by_resource_group(resource_group_name, custom_headers = nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(resource_group_name, custom_headers = nil) ⇒ DomainCollection

Get all domains in a resource group.

Get all domains in a resource group.

resource belongs. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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

    A hash of custom headers that

Returns:

  • (DomainCollection)

    which provide lazy access to pages of the



1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1854

def list_by_resource_group_as_lazy(resource_group_name, custom_headers = nil)
  response = list_by_resource_group_async(resource_group_name, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers)
    end
    page
  end
end

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

Get all domains in a resource group.

Get all domains in a resource group.

resource belongs. to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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

def list_by_resource_group_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?
  api_version = '2015-04-01'


  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'

  request_url = @base_url || @client.base_url

  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' => 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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainCollection.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_by_resource_group_next(next_page_link, custom_headers = nil) ⇒ DomainCollection

Get all domains in a resource group.

Get all domains in a resource group.

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:

  • (DomainCollection)

    operation results.



1621
1622
1623
1624
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1621

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

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

Get all domains in a resource group.

Get all domains in a resource group.

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.



1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1654

def list_by_resource_group_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}'

  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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainCollection.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_by_resource_group_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get all domains in a resource group.

Get all domains in a resource group.

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.



1638
1639
1640
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1638

def list_by_resource_group_next_with_http_info(next_page_link, custom_headers = nil)
  list_by_resource_group_next_async(next_page_link, custom_headers).value!
end

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

Get all domains in a resource group.

Get all domains in a resource group.

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



438
439
440
# File 'lib/generated/azure_mgmt_web/domains.rb', line 438

def list_by_resource_group_with_http_info(resource_group_name, custom_headers = nil)
  list_by_resource_group_async(resource_group_name, custom_headers).value!
end

#list_next(next_page_link, custom_headers = nil) ⇒ DomainCollection

Get all domains in a subscription.

Get all domains in a subscription.

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:

  • (DomainCollection)

    operation results.



1435
1436
1437
1438
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1435

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

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

Get all domains in a subscription.

Get all domains in a subscription.

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.



1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1468

def list_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}'

  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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainCollection.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 domains in a subscription.

Get all domains in a subscription.

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.



1452
1453
1454
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1452

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

#list_ownership_identifiers(resource_group_name, domain_name, custom_headers = nil) ⇒ Array<DomainOwnershipIdentifier>

Lists domain ownership identifiers.

Lists domain ownership identifiers.

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

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

    A hash of custom headers that

Returns:

  • (Array<DomainOwnershipIdentifier>)

    operation results.



764
765
766
767
# File 'lib/generated/azure_mgmt_web/domains.rb', line 764

def list_ownership_identifiers(resource_group_name, domain_name, custom_headers = nil)
  first_page = list_ownership_identifiers_as_lazy(resource_group_name, domain_name, custom_headers)
  first_page.get_all_items
end

#list_ownership_identifiers_as_lazy(resource_group_name, domain_name, custom_headers = nil) ⇒ DomainOwnershipIdentifierCollection

Lists domain ownership identifiers.

Lists domain ownership identifiers.

resource belongs. will be added to the HTTP request.

pages of the response.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

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

    A hash of custom headers that

Returns:

  • (DomainOwnershipIdentifierCollection)

    which provide lazy access to



1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1879

def list_ownership_identifiers_as_lazy(resource_group_name, domain_name, custom_headers = nil)
  response = list_ownership_identifiers_async(resource_group_name, domain_name, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_ownership_identifiers_next_async(next_page_link, custom_headers)
    end
    page
  end
end

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

Lists domain ownership identifiers.

Lists domain ownership identifiers.

resource belongs. to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
# File 'lib/generated/azure_mgmt_web/domains.rb', line 799

def list_ownership_identifiers_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?
  api_version = '2015-04-01'


  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}/domainOwnershipIdentifiers'

  request_url = @base_url || @client.base_url

  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' => 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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainOwnershipIdentifierCollection.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_ownership_identifiers_next(next_page_link, custom_headers = nil) ⇒ DomainOwnershipIdentifierCollection

Lists domain ownership identifiers.

Lists domain ownership identifiers.

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:

  • (DomainOwnershipIdentifierCollection)

    operation results.



1714
1715
1716
1717
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1714

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

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

Lists domain ownership identifiers.

Lists domain ownership identifiers.

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.



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1747

def list_ownership_identifiers_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}'

  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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainOwnershipIdentifierCollection.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_ownership_identifiers_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists domain ownership identifiers.

Lists domain ownership identifiers.

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.



1731
1732
1733
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1731

def list_ownership_identifiers_next_with_http_info(next_page_link, custom_headers = nil)
  list_ownership_identifiers_next_async(next_page_link, custom_headers).value!
end

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

Lists domain ownership identifiers.

Lists domain ownership identifiers.

resource belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



782
783
784
# File 'lib/generated/azure_mgmt_web/domains.rb', line 782

def list_ownership_identifiers_with_http_info(resource_group_name, domain_name, custom_headers = nil)
  list_ownership_identifiers_async(resource_group_name, domain_name, custom_headers).value!
end

#list_recommendations(parameters, custom_headers = nil) ⇒ Array<NameIdentifier>

Get domain name recommendations based on keywords.

Get domain name recommendations based on keywords.

for domain name recommendations. will be added to the HTTP request.

Parameters:

  • parameters (DomainRecommendationSearchParameters)

    Search parameters

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

    A hash of custom headers that

Returns:

  • (Array<NameIdentifier>)

    operation results.



316
317
318
319
# File 'lib/generated/azure_mgmt_web/domains.rb', line 316

def list_recommendations(parameters, custom_headers = nil)
  first_page = list_recommendations_as_lazy(parameters, custom_headers)
  first_page.get_all_items
end

#list_recommendations_as_lazy(parameters, custom_headers = nil) ⇒ NameIdentifierCollection

Get domain name recommendations based on keywords.

Get domain name recommendations based on keywords.

for domain name recommendations. will be added to the HTTP request.

response.

Parameters:

  • parameters (DomainRecommendationSearchParameters)

    Search parameters

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

    A hash of custom headers that

Returns:

  • (NameIdentifierCollection)

    which provide lazy access to pages of the



1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1830

def list_recommendations_as_lazy(parameters, custom_headers = nil)
  response = list_recommendations_async(parameters, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_recommendations_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_recommendations_async(parameters, custom_headers = nil) ⇒ Concurrent::Promise

Get domain name recommendations based on keywords.

Get domain name recommendations based on keywords.

for domain name recommendations. to the HTTP request.

Parameters:

  • parameters (DomainRecommendationSearchParameters)

    Search parameters

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'lib/generated/azure_mgmt_web/domains.rb', line 349

def list_recommendations_async(parameters, custom_headers = nil)
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  api_version = '2015-04-01'


  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 = Azure::ARM::Web::Models::DomainRecommendationSearchParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations'

  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' => 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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::NameIdentifierCollection.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_recommendations_next(next_page_link, custom_headers = nil) ⇒ NameIdentifierCollection

Get domain name recommendations based on keywords.

Get domain name recommendations based on keywords.

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:

  • (NameIdentifierCollection)

    operation results.



1528
1529
1530
1531
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1528

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

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

Get domain name recommendations based on keywords.

Get domain name recommendations based on keywords.

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.



1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1561

def list_recommendations_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}'

  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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::NameIdentifierCollection.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_recommendations_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get domain name recommendations based on keywords.

Get domain name recommendations based on keywords.

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.



1545
1546
1547
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1545

def list_recommendations_next_with_http_info(next_page_link, custom_headers = nil)
  list_recommendations_next_async(next_page_link, custom_headers).value!
end

#list_recommendations_with_http_info(parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get domain name recommendations based on keywords.

Get domain name recommendations based on keywords.

for domain name recommendations. will be added to the HTTP request.

Parameters:

  • parameters (DomainRecommendationSearchParameters)

    Search parameters

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



333
334
335
# File 'lib/generated/azure_mgmt_web/domains.rb', line 333

def list_recommendations_with_http_info(parameters, custom_headers = nil)
  list_recommendations_async(parameters, custom_headers).value!
end

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

Get all domains in a subscription.

Get all domains in a subscription.

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.



151
152
153
# File 'lib/generated/azure_mgmt_web/domains.rb', line 151

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

#update_ownership_identifier(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil) ⇒ DomainOwnershipIdentifier

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

resource belongs. representation of the domain ownership properties. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

  • domain_ownership_identifier (DomainOwnershipIdentifier)

    A JSON

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

    A hash of custom headers that

Returns:

  • (DomainOwnershipIdentifier)

    operation results.



1192
1193
1194
1195
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1192

def update_ownership_identifier(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil)
  response = update_ownership_identifier_async(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers).value!
  response.body unless response.nil?
end

#update_ownership_identifier_async(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil) ⇒ Concurrent::Promise

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

resource belongs. representation of the domain ownership properties. to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

  • domain_ownership_identifier (DomainOwnershipIdentifier)

    A JSON

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1237

def update_ownership_identifier_async(resource_group_name, domain_name, name, domain_ownership_identifier, 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, 'name is nil' if name.nil?
  fail ArgumentError, 'domain_ownership_identifier is nil' if domain_ownership_identifier.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  api_version = '2015-04-01'


  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 = Azure::ARM::Web::Models::DomainOwnershipIdentifier.mapper()
  request_content = @client.serialize(request_mapper,  domain_ownership_identifier)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'domainName' => domain_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, 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 MsRestAzure::AzureOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Web::Models::DomainOwnershipIdentifier.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

#update_ownership_identifier_with_http_info(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

Creates an ownership identifier for a domain or updates identifier details for an existing identifer

resource belongs. representation of the domain ownership properties. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of the resource group to which the

  • domain_name (String)

    Name of domain.

  • name (String)

    Name of identifier.

  • domain_ownership_identifier (DomainOwnershipIdentifier)

    A JSON

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1215
1216
1217
# File 'lib/generated/azure_mgmt_web/domains.rb', line 1215

def update_ownership_identifier_with_http_info(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers = nil)
  update_ownership_identifier_async(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers).value!
end