Class: Azure::CognitiveServices::Mgmt::V2017_04_18::CognitiveServicesManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ CognitiveServicesManagementClient

Creates initializes a new instance of the CognitiveServicesManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

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

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 59

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @accounts = Accounts.new(self)
  @resource_skus = ResourceSkus.new(self)
  @operations = Operations.new(self)
  @private_endpoint_connections = PrivateEndpointConnections.new(self)
  @private_link_resources = PrivateLinkResources.new(self)
  @api_version = '2017-04-18'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



27
28
29
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 27

def accept_language
  @accept_language
end

#accounts ⇒ Accounts (readonly)

Returns accounts.

Returns:



39
40
41
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 39

def accounts
  @accounts
end

#api_version ⇒ String (readonly)

Returns The API version to use for this operation.

Returns:

  • (String) —

    The API version to use for this operation.



24
25
26
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 24

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



36
37
38
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 36

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



31
32
33
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 31

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



45
46
47
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 45

def operations
  @operations
end

#private_endpoint_connections ⇒ PrivateEndpointConnections (readonly)

Returns private_endpoint_connections.

Returns:



48
49
50
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 48

def private_endpoint_connections
  @private_endpoint_connections
end

#private_link_resources ⇒ PrivateLinkResources (readonly)

Returns private_link_resources.

Returns:



51
52
53
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 51

def private_link_resources
  @private_link_resources
end

#resource_skus ⇒ ResourceSkus (readonly)

Returns resource_skus.

Returns:



42
43
44
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 42

def resource_skus
  @resource_skus
end

#subscription_id ⇒ String

Returns The ID of the target subscription.

Returns:

  • (String) —

    The ID of the target subscription.



21
22
23
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 21

def subscription_id
  @subscription_id
end

Instance Method Details

#check_domain_availability(subdomain_name, type, custom_headers: nil) ⇒ CheckDomainAvailabilityResult

Check whether a domain is available.

will be added to the HTTP request.

Parameters:

  • subdomain_name (String) —

    The subdomain name to use.

  • type (String) —

    The Type of the resource.

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

    A hash of custom headers that

Returns:

  • (CheckDomainAvailabilityResult) —

    operation results.



263
264
265
266
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 263

def check_domain_availability(subdomain_name, type, custom_headers:nil)
  response = check_domain_availability_async(subdomain_name, type, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_domain_availability_async(subdomain_name, type, custom_headers: nil) ⇒ Concurrent::Promise

Check whether a domain is available.

to the HTTP request.

Parameters:

  • subdomain_name (String) —

    The subdomain name to use.

  • type (String) —

    The Type of the resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 292

def check_domain_availability_async(subdomain_name, type, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, "'subscription_id' should satisfy the constraint - 'MinLength': '1'" if !subscription_id.nil? && subscription_id.length < 1
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, "'api_version' should satisfy the constraint - 'MinLength': '1'" if !api_version.nil? && api_version.length < 1
  fail ArgumentError, 'subdomain_name is nil' if subdomain_name.nil?
  fail ArgumentError, 'type is nil' if type.nil?

  parameters = Azure::CognitiveServices::Mgmt::V2017_04_18::Models::CheckDomainAvailabilityParameter.new
  unless subdomain_name.nil? && type.nil?
    parameters.subdomain_name = subdomain_name
    parameters.type = type
  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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::Mgmt::V2017_04_18::Models::CheckDomainAvailabilityParameter.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

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

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CognitiveServices::Mgmt::V2017_04_18::Models::CheckDomainAvailabilityResult.mapper()
        result.body = self.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_domain_availability_with_http_info(subdomain_name, type, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Check whether a domain is available.

will be added to the HTTP request.

Parameters:

  • subdomain_name (String) —

    The subdomain name to use.

  • type (String) —

    The Type of the resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



278
279
280
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 278

def check_domain_availability_with_http_info(subdomain_name, type, custom_headers:nil)
  check_domain_availability_async(subdomain_name, type, custom_headers:custom_headers).value!
end

#check_sku_availability(location, skus, kind, type, custom_headers: nil) ⇒ CheckSkuAvailabilityResultList

Check available SKUs.

will be added to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • skus (Array<String>) —

    The SKU of the resource.

  • kind (String) —

    The Kind of the resource.

  • type (String) —

    The Type of the resource.

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

    A hash of custom headers that

Returns:

  • (CheckSkuAvailabilityResultList) —

    operation results.



148
149
150
151
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 148

def check_sku_availability(location, skus, kind, type, custom_headers:nil)
  response = check_sku_availability_async(location, skus, kind, type, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_sku_availability_async(location, skus, kind, type, custom_headers: nil) ⇒ Concurrent::Promise

Check available SKUs.

to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • skus (Array<String>) —

    The SKU of the resource.

  • kind (String) —

    The Kind of the resource.

  • type (String) —

    The Type of the resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 181

def check_sku_availability_async(location, skus, kind, type, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, "'subscription_id' should satisfy the constraint - 'MinLength': '1'" if !subscription_id.nil? && subscription_id.length < 1
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, "'api_version' should satisfy the constraint - 'MinLength': '1'" if !api_version.nil? && api_version.length < 1
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'skus is nil' if skus.nil?
  fail ArgumentError, 'kind is nil' if kind.nil?
  fail ArgumentError, 'type is nil' if type.nil?

  parameters = Azure::CognitiveServices::Mgmt::V2017_04_18::Models::CheckSkuAvailabilityParameter.new
  unless skus.nil? && kind.nil? && type.nil?
    parameters.skus = skus
    parameters.kind = kind
    parameters.type = type
  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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::Mgmt::V2017_04_18::Models::CheckSkuAvailabilityParameter.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'location' => location},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CognitiveServices::Mgmt::V2017_04_18::Models::CheckSkuAvailabilityResultList.mapper()
        result.body = self.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_sku_availability_with_http_info(location, skus, kind, type, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Check available SKUs.

will be added to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • skus (Array<String>) —

    The SKU of the resource.

  • kind (String) —

    The Kind of the resource.

  • type (String) —

    The Type of the resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



165
166
167
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 165

def check_sku_availability_with_http_info(location, skus, kind, type, custom_headers:nil)
  check_sku_availability_async(location, skus, kind, type, custom_headers:custom_headers).value!
end

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



94
95
96
97
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 94

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 119

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



106
107
108
109
110
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb', line 106

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end