Class: Azure::ARM::Dns::Zones

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_dns/zones.rb

Overview

The DNS Management Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Zones

Creates and initializes a new instance of the Zones class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DnsManagementClient (readonly)

Returns reference to the DnsManagementClient.

Returns:



23
24
25
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 23

def client
  @client
end

Instance Method Details

#begin_delete(resource_group_name, zone_name, if_match = nil, custom_headers = nil) ⇒ ZoneDeleteResult

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

dot). delete the current zone. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

  • if_match (String) (defaults to: nil) —

    The etag of the DNS zone. Omit this value to always

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

    A hash of custom headers that

Returns:



507
508
509
510
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 507

def begin_delete(resource_group_name, zone_name, if_match = nil, custom_headers = nil)
  response = begin_delete_async(resource_group_name, zone_name, if_match, custom_headers).value!
  response.body unless response.nil?
end

#begin_delete_async(resource_group_name, zone_name, if_match = nil, custom_headers = nil) ⇒ Concurrent::Promise

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

dot). delete the current zone. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

  • if_match (String) (defaults to: nil) —

    The etag of the DNS zone. Omit this value to always

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



546
547
548
549
550
551
552
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
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 546

def begin_delete_async(resource_group_name, zone_name, if_match = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'zone_name is nil' if zone_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['If-Match'] = if_match unless if_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'zoneName' => zone_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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 == 204 || 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 == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = ZoneDeleteResult.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

#begin_delete_with_http_info(resource_group_name, zone_name, if_match = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

dot). delete the current zone. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

  • if_match (String) (defaults to: nil) —

    The etag of the DNS zone. Omit this value to always

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



527
528
529
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 527

def begin_delete_with_http_info(resource_group_name, zone_name, if_match = nil, custom_headers = nil)
  begin_delete_async(resource_group_name, zone_name, if_match, custom_headers).value!
end

#create_or_update(resource_group_name, zone_name, parameters, if_match = nil, if_none_match = nil, custom_headers = nil) ⇒ Zone

Creates or updates a DNS zone. Does not modify DNS records within the zone.

dot). overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes. created, but to prevent updating an existing zone. Other values will be ignored. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

  • parameters (Zone) —

    Parameters supplied to the CreateOrUpdate operation.

  • if_match (String) (defaults to: nil) —

    The etag of the DNS zone. Omit this value to always

  • if_none_match (String) (defaults to: nil) —

    Set to ‘*’ to allow a new DNS zone to be

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

    A hash of custom headers that

Returns:

  • (Zone) —

    operation results.



43
44
45
46
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 43

def create_or_update(resource_group_name, zone_name, parameters, if_match = nil, if_none_match = nil, custom_headers = nil)
  response = create_or_update_async(resource_group_name, zone_name, parameters, if_match, if_none_match, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, zone_name, parameters, if_match = nil, if_none_match = nil, custom_headers = nil) ⇒ Concurrent::Promise

Creates or updates a DNS zone. Does not modify DNS records within the zone.

dot). overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes. created, but to prevent updating an existing zone. Other values will be ignored. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

  • parameters (Zone) —

    Parameters supplied to the CreateOrUpdate operation.

  • if_match (String) (defaults to: nil) —

    The etag of the DNS zone. Omit this value to always

  • if_none_match (String) (defaults to: nil) —

    Set to ‘*’ to allow a new DNS zone to be

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 88

def create_or_update_async(resource_group_name, zone_name, parameters, if_match = nil, if_none_match = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'zone_name is nil' if zone_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['If-Match'] = if_match unless if_match.nil?
  request_headers['If-None-Match'] = if_none_match unless if_none_match.nil?
  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 = Zone.mapper()
  request_content = @client.serialize(request_mapper,  parameters, 'parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'zoneName' => zone_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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 || status_code == 201
      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 = Zone.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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Zone.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_with_http_info(resource_group_name, zone_name, parameters, if_match = nil, if_none_match = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a DNS zone. Does not modify DNS records within the zone.

dot). overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes. created, but to prevent updating an existing zone. Other values will be ignored. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

  • parameters (Zone) —

    Parameters supplied to the CreateOrUpdate operation.

  • if_match (String) (defaults to: nil) —

    The etag of the DNS zone. Omit this value to always

  • if_none_match (String) (defaults to: nil) —

    Set to ‘*’ to allow a new DNS zone to be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



66
67
68
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 66

def create_or_update_with_http_info(resource_group_name, zone_name, parameters, if_match = nil, if_none_match = nil, custom_headers = nil)
  create_or_update_async(resource_group_name, zone_name, parameters, if_match, if_none_match, custom_headers).value!
end

#delete(resource_group_name, zone_name, if_match = nil, custom_headers = nil) ⇒ ZoneDeleteResult

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

dot). delete the current zone. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

  • if_match (String) (defaults to: nil) —

    The etag of the DNS zone. Omit this value to always

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

    A hash of custom headers that

Returns:



177
178
179
180
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 177

def delete(resource_group_name, zone_name, if_match = nil, custom_headers = nil)
  response = delete_async(resource_group_name, zone_name, if_match, custom_headers).value!
  response.body unless response.nil?
end

#delete_async(resource_group_name, zone_name, if_match = nil, custom_headers = nil) ⇒ Concurrent::Promise

dot). delete the current zone. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

  • if_match (String) (defaults to: nil) —

    The etag of the DNS zone. Omit this value to always

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 195

def delete_async(resource_group_name, zone_name, if_match = nil, custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, zone_name, if_match, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = ZoneDeleteResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

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

  promise
end

#get(resource_group_name, zone_name, custom_headers = nil) ⇒ Zone

Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.

dot). will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

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

    A hash of custom headers that

Returns:

  • (Zone) —

    operation results.



225
226
227
228
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 225

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

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

Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.

dot). to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

  • 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
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 258

def get_async(resource_group_name, zone_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'zone_name is nil' if zone_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Network/dnsZones/{zoneName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'zoneName' => zone_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail 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 = Zone.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_with_http_info(resource_group_name, zone_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.

dot). will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • zone_name (String) —

    The name of the DNS zone (without a terminating

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



242
243
244
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 242

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

#list(top = nil, custom_headers = nil) ⇒ Array<Zone>

Lists the DNS zones in all resource groups in a subscription.

specified, returns up to 100 zones. will be added to the HTTP request.

Parameters:

  • top (Integer) (defaults to: nil) —

    The maximum number of DNS zones to return. If not

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

    A hash of custom headers that

Returns:

  • (Array<Zone>) —

    operation results.



413
414
415
416
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 413

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

#list_as_lazy(top = nil, custom_headers = nil) ⇒ ZoneListResult

Lists the DNS zones in all resource groups in a subscription.

specified, returns up to 100 zones. will be added to the HTTP request.

Parameters:

  • top (Integer) (defaults to: nil) —

    The maximum number of DNS zones to return. If not

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

    A hash of custom headers that

Returns:

  • (ZoneListResult) —

    which provide lazy access to pages of the response.



805
806
807
808
809
810
811
812
813
814
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 805

def list_as_lazy(top = nil, custom_headers = nil)
  response = list_async(top, 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(top = nil, custom_headers = nil) ⇒ Concurrent::Promise

Lists the DNS zones in all resource groups in a subscription.

specified, returns up to 100 zones. to the HTTP request.

Parameters:

  • top (Integer) (defaults to: nil) —

    The maximum number of DNS zones to return. If not

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



442
443
444
445
446
447
448
449
450
451
452
453
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
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 442

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


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones'

  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: {'$top' => top,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail 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 = ZoneListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group(resource_group_name, top = nil, custom_headers = nil) ⇒ Array<Zone>

Lists the DNS zones within a resource group.

specified, returns up to 100 record sets. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • top (Integer) (defaults to: nil) —

    The maximum number of record sets to return. If not

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

    A hash of custom headers that

Returns:

  • (Array<Zone>) —

    operation results.



321
322
323
324
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 321

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

#list_by_resource_group_as_lazy(resource_group_name, top = nil, custom_headers = nil) ⇒ ZoneListResult

Lists the DNS zones within a resource group.

specified, returns up to 100 record sets. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • top (Integer) (defaults to: nil) —

    The maximum number of record sets to return. If not

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

    A hash of custom headers that

Returns:

  • (ZoneListResult) —

    which provide lazy access to pages of the response.



784
785
786
787
788
789
790
791
792
793
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 784

def list_by_resource_group_as_lazy(resource_group_name, top = nil, custom_headers = nil)
  response = list_by_resource_group_async(resource_group_name, top, 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, top = nil, custom_headers = nil) ⇒ Concurrent::Promise

Lists the DNS zones within a resource group.

specified, returns up to 100 record sets. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • top (Integer) (defaults to: nil) —

    The maximum number of record sets to return. If not

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 352

def list_by_resource_group_async(resource_group_name, top = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Network/dnsZones'

  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: {'$top' => top,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail 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 = ZoneListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group_next(next_page_link, custom_headers = nil) ⇒ ZoneListResult

Lists the DNS zones within 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:



609
610
611
612
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 609

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

Lists the DNS zones within 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.



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 638

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 = ZoneListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Lists the DNS zones within 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.



624
625
626
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 624

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, top = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the DNS zones within a resource group.

specified, returns up to 100 record sets. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • top (Integer) (defaults to: nil) —

    The maximum number of record sets to return. If not

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



337
338
339
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 337

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

#list_next(next_page_link, custom_headers = nil) ⇒ ZoneListResult

Lists the DNS zones in all resource groups 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:



696
697
698
699
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 696

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

Lists the DNS zones in all resource groups 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.



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
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 725

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 = ZoneListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Lists the DNS zones in all resource groups 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.



711
712
713
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 711

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

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

Lists the DNS zones in all resource groups in a subscription.

specified, returns up to 100 zones. will be added to the HTTP request.

Parameters:

  • top (Integer) (defaults to: nil) —

    The maximum number of DNS zones to return. If not

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



428
429
430
 
# File 'lib/generated/azure_mgmt_dns/zones.rb', line 428

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