Class: Azure::BatchAI::Mgmt::V2017_09_01_preview::FileServers

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb

Overview

The Azure BatchAI Management API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ FileServers

Creates and initializes a new instance of the FileServers class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ BatchAIManagementClient (readonly)

Returns reference to the BatchAIManagementClient.

Returns:



22
23
24
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, file_server_name, parameters, custom_headers: nil) ⇒ FileServer

Creates a file server.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. file server creation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

  • parameters (FileServerCreateParameters) —

    The parameters to provide for

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

    A hash of custom headers that

Returns:

  • (FileServer) —

    operation results.



475
476
477
478
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 475

def begin_create(resource_group_name, file_server_name, parameters, custom_headers:nil)
  response = begin_create_async(resource_group_name, file_server_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, file_server_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a file server.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. file server creation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

  • parameters (FileServerCreateParameters) —

    The parameters to provide for

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
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
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 516

def begin_create_async(resource_group_name, file_server_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'file_server_name is nil' if file_server_name.nil?
  fail ArgumentError, "'file_server_name' should satisfy the constraint - 'MaxLength': '64'" if !file_server_name.nil? && file_server_name.length > 64
  fail ArgumentError, "'file_server_name' should satisfy the constraint - 'MinLength': '1'" if !file_server_name.nil? && file_server_name.length < 1
  fail ArgumentError, "'file_server_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !file_server_name.nil? && file_server_name.match(Regexp.new('^^[-\w\._]+$$')).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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::FileServerCreateParameters.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}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/fileServers/{fileServerName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'fileServerName' => file_server_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 == 202
      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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::FileServer.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_with_http_info(resource_group_name, file_server_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a file server.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. file server creation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

  • parameters (FileServerCreateParameters) —

    The parameters to provide for

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



496
497
498
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 496

def begin_create_with_http_info(resource_group_name, file_server_name, parameters, custom_headers:nil)
  begin_create_async(resource_group_name, file_server_name, parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, file_server_name, custom_headers: nil) ⇒ Object

Delete a file Server.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

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

    A hash of custom headers that



596
597
598
599
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 596

def begin_delete(resource_group_name, file_server_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, file_server_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, file_server_name, custom_headers: nil) ⇒ Concurrent::Promise

Delete a file Server.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



633
634
635
636
637
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
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 633

def begin_delete_async(resource_group_name, file_server_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'file_server_name is nil' if file_server_name.nil?
  fail ArgumentError, "'file_server_name' should satisfy the constraint - 'MaxLength': '64'" if !file_server_name.nil? && file_server_name.length > 64
  fail ArgumentError, "'file_server_name' should satisfy the constraint - 'MinLength': '1'" if !file_server_name.nil? && file_server_name.length < 1
  fail ArgumentError, "'file_server_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !file_server_name.nil? && file_server_name.match(Regexp.new('^^[-\w\._]+$$')).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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'fileServerName' => file_server_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 == 200 || status_code == 202 || 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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, file_server_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete a file Server.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



615
616
617
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 615

def begin_delete_with_http_info(resource_group_name, file_server_name, custom_headers:nil)
  begin_delete_async(resource_group_name, file_server_name, custom_headers:custom_headers).value!
end

#create(resource_group_name, file_server_name, parameters, custom_headers: nil) ⇒ FileServer

Creates a file server.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. file server creation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

  • parameters (FileServerCreateParameters) —

    The parameters to provide for

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

    A hash of custom headers that

Returns:

  • (FileServer) —

    operation results.



40
41
42
43
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 40

def create(resource_group_name, file_server_name, parameters, custom_headers:nil)
  response = create_async(resource_group_name, file_server_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, file_server_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. file server creation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

  • parameters (FileServerCreateParameters) —

    The parameters to provide for

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 60

def create_async(resource_group_name, file_server_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_async(resource_group_name, file_server_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::FileServer.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

#delete(resource_group_name, file_server_name, custom_headers: nil) ⇒ Object

Delete a file Server.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

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

    A hash of custom headers that



90
91
92
93
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 90

def delete(resource_group_name, file_server_name, custom_headers:nil)
  response = delete_async(resource_group_name, file_server_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, file_server_name, custom_headers: nil) ⇒ Concurrent::Promise

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 108

def delete_async(resource_group_name, file_server_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, file_server_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

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

  promise
end

#get(resource_group_name, file_server_name, custom_headers: nil) ⇒ FileServer

Gets information about the specified Cluster.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

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

    A hash of custom headers that

Returns:

  • (FileServer) —

    operation results.



138
139
140
141
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 138

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

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

Gets information about the specified Cluster.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 175

def get_async(resource_group_name, file_server_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'file_server_name is nil' if file_server_name.nil?
  fail ArgumentError, "'file_server_name' should satisfy the constraint - 'MaxLength': '64'" if !file_server_name.nil? && file_server_name.length > 64
  fail ArgumentError, "'file_server_name' should satisfy the constraint - 'MinLength': '1'" if !file_server_name.nil? && file_server_name.length < 1
  fail ArgumentError, "'file_server_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !file_server_name.nil? && file_server_name.match(Regexp.new('^^[-\w\._]+$$')).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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'fileServerName' => file_server_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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::FileServer.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Gets information about the specified Cluster.

resource belongs. specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

  • file_server_name (String) —

    The name of the file server within the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



157
158
159
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 157

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

#list(file_servers_list_options: nil, custom_headers: nil) ⇒ Array<FileServer>

To list all the file servers available under the given subscription (and across all resource groups within that subscription)

parameters for the operation will be added to the HTTP request.

Parameters:

  • file_servers_list_options (FileServersListOptions) (defaults to: nil) —

    Additional

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

    A hash of custom headers that

Returns:

  • (Array<FileServer>) —

    operation results.



245
246
247
248
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 245

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

#list_as_lazy(file_servers_list_options: nil, custom_headers: nil) ⇒ FileServerListResult

To list all the file servers available under the given subscription (and across all resource groups within that subscription)

parameters for the operation will be added to the HTTP request.

response.

Parameters:

  • file_servers_list_options (FileServersListOptions) (defaults to: nil) —

    Additional

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

    A hash of custom headers that

Returns:

  • (FileServerListResult) —

    which provide lazy access to pages of the



880
881
882
883
884
885
886
887
888
889
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 880

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

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

To list all the file servers available under the given subscription (and across all resource groups within that subscription)

parameters for the operation to the HTTP request.

Parameters:

  • file_servers_list_options (FileServersListOptions) (defaults to: nil) —

    Additional

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 276

def list_async(file_servers_list_options: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?

  filter = nil
  select = nil
  max_results = nil
  unless file_servers_list_options.nil?
    filter = file_servers_list_options.filter
  end
  unless file_servers_list_options.nil?
    select = file_servers_list_options.select
  end
  unless file_servers_list_options.nil?
    max_results = file_servers_list_options.maxResults
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$select' => select,'maxresults' => max_results},
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::FileServerListResult.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, file_servers_list_by_resource_group_options: nil, custom_headers: nil) ⇒ Array<FileServer>

Gets a formatted list of file servers and their properties associated within the specified resource group.

resource belongs.

FileServersListByResourceGroupOptions

Additional parameters for the

operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

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

    A hash of custom headers that

Returns:

  • (Array<FileServer>) —

    operation results.



355
356
357
358
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 355

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

#list_by_resource_group_as_lazy(resource_group_name, file_servers_list_by_resource_group_options: nil, custom_headers: nil) ⇒ FileServerListResult

Gets a formatted list of file servers and their properties associated within the specified resource group.

resource belongs.

FileServersListByResourceGroupOptions

Additional parameters for the

operation will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

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

    A hash of custom headers that

Returns:

  • (FileServerListResult) —

    which provide lazy access to pages of the



906
907
908
909
910
911
912
913
914
915
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 906

def list_by_resource_group_as_lazy(resource_group_name, file_servers_list_by_resource_group_options:nil, custom_headers:nil)
  response = list_by_resource_group_async(resource_group_name, file_servers_list_by_resource_group_options:file_servers_list_by_resource_group_options, custom_headers: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:custom_headers)
    end
    page
  end
end

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

Gets a formatted list of file servers and their properties associated within the specified resource group.

resource belongs.

FileServersListByResourceGroupOptions

Additional parameters for the

operation to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 392

def list_by_resource_group_async(resource_group_name, file_servers_list_by_resource_group_options:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).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?

  filter = nil
  select = nil
  max_results = nil
  unless file_servers_list_by_resource_group_options.nil?
    filter = file_servers_list_by_resource_group_options.filter
  end
  unless file_servers_list_by_resource_group_options.nil?
    select = file_servers_list_by_resource_group_options.select
  end
  unless file_servers_list_by_resource_group_options.nil?
    max_results = file_servers_list_by_resource_group_options.maxResults
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

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

  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' => @client.api_version,'$filter' => filter,'$select' => select,'maxresults' => max_results},
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::FileServerListResult.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) ⇒ FileServerListResult

Gets a formatted list of file servers and their properties associated within the specified 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:

  • (FileServerListResult) —

    operation results.



786
787
788
789
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 786

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

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

Gets a formatted list of file servers and their properties associated within the specified 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.



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
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 817

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail 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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::FileServerListResult.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

Gets a formatted list of file servers and their properties associated within the specified 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.



802
803
804
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 802

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:custom_headers).value!
end

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

Gets a formatted list of file servers and their properties associated within the specified resource group.

resource belongs.

FileServersListByResourceGroupOptions

Additional parameters for the

operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group to which the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



374
375
376
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 374

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

#list_next(next_page_link, custom_headers: nil) ⇒ FileServerListResult

To list all the file servers available under the given subscription (and across all resource groups within that 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:

  • (FileServerListResult) —

    operation results.



693
694
695
696
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 693

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

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

To list all the file servers available under the given subscription (and across all resource groups within that 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.



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
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 724

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail 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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::FileServerListResult.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

To list all the file servers available under the given subscription (and across all resource groups within that 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.



709
710
711
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 709

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

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

To list all the file servers available under the given subscription (and across all resource groups within that subscription)

parameters for the operation will be added to the HTTP request.

Parameters:

  • file_servers_list_options (FileServersListOptions) (defaults to: nil) —

    Additional

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



261
262
263
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/file_servers.rb', line 261

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