Class: Azure::Batch::Mgmt::V2019_08_01::Location

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01/generated/azure_mgmt_batch/location.rb

Overview

Location

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Location

Creates and initializes a new instance of the Location class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/location.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ BatchManagementClient (readonly)

Returns reference to the BatchManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/location.rb', line 22

def client
  @client
end

Instance Method Details

#check_name_availability(location_name, parameters, custom_headers: nil) ⇒ CheckNameAvailabilityResult

Checks whether the Batch account name is available in the specified region.

check the availability of a name. will be added to the HTTP request.

Parameters:

  • location_name (String) —

    The desired region for the name check.

  • parameters (CheckNameAvailabilityParameters) —

    Properties needed to

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

    A hash of custom headers that

Returns:

  • (CheckNameAvailabilityResult) —

    operation results.



131
132
133
134
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/location.rb', line 131

def check_name_availability(location_name, parameters, custom_headers:nil)
  response = check_name_availability_async(location_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_name_availability_async(location_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Checks whether the Batch account name is available in the specified region.

check the availability of a name. to the HTTP request.

Parameters:

  • location_name (String) —

    The desired region for the name check.

  • parameters (CheckNameAvailabilityParameters) —

    Properties needed to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/location.rb', line 162

def check_name_availability_async(location_name, parameters, custom_headers:nil)
  fail ArgumentError, 'location_name is nil' if location_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?
  fail ArgumentError, 'parameters is nil' if parameters.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::Batch::Mgmt::V2019_08_01::Models::CheckNameAvailabilityParameters.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.Batch/locations/{locationName}/checkNameAvailability'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'locationName' => location_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(: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?
    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::Batch::Mgmt::V2019_08_01::Models::CheckNameAvailabilityResult.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_name_availability_with_http_info(location_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Checks whether the Batch account name is available in the specified region.

check the availability of a name. will be added to the HTTP request.

Parameters:

  • location_name (String) —

    The desired region for the name check.

  • parameters (CheckNameAvailabilityParameters) —

    Properties needed to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



147
148
149
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/location.rb', line 147

def check_name_availability_with_http_info(location_name, parameters, custom_headers:nil)
  check_name_availability_async(location_name, parameters, custom_headers:custom_headers).value!
end

#get_quotas(location_name, custom_headers: nil) ⇒ BatchLocationQuota

Gets the Batch service quotas for the specified subscription at the given location.

quotas. will be added to the HTTP request.

Parameters:

  • location_name (String) —

    The region for which to retrieve Batch service

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

    A hash of custom headers that

Returns:

  • (BatchLocationQuota) —

    operation results.



35
36
37
38
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/location.rb', line 35

def get_quotas(location_name, custom_headers:nil)
  response = get_quotas_async(location_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_quotas_async(location_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the Batch service quotas for the specified subscription at the given location.

quotas. to the HTTP request.

Parameters:

  • location_name (String) —

    The region for which to retrieve Batch service

  • 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
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/location.rb', line 66

def get_quotas_async(location_name, custom_headers:nil)
  fail ArgumentError, 'location_name is nil' if location_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 = {}
  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.Batch/locations/{locationName}/quotas'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'locationName' => location_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::Batch::Mgmt::V2019_08_01::Models::BatchLocationQuota.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_quotas_with_http_info(location_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the Batch service quotas for the specified subscription at the given location.

quotas. will be added to the HTTP request.

Parameters:

  • location_name (String) —

    The region for which to retrieve Batch service

  • 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/2019-08-01/generated/azure_mgmt_batch/location.rb', line 51

def get_quotas_with_http_info(location_name, custom_headers:nil)
  get_quotas_async(location_name, custom_headers:custom_headers).value!
end