class Azure::CognitiveServices::Mgmt::V2017_04_18::CognitiveServicesManagementClient
A service client - single point of access to the REST API.
Attributes
@return [String] The preferred language for the response.
@return [Accounts] accounts
@return [String] The API version to use for this operation.
@return [String] the base URI of the service.
@return Credentials needed for the client to connect to Azure
.
@return [Boolean] Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.
@return [Integer] The retry timeout in seconds for Long Running Operations
. Default value is 30.
@return [Operations] operations
@return [PrivateEndpointConnections] private_endpoint_connections
@return [PrivateLinkResources] private_link_resources
@return [ResourceSkus] resource_skus
@return [String] The ID of the target subscription.
Public Class Methods
Creates initializes a new instance of the CognitiveServicesManagementClient
class. @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client. @param base_url
[String] the base URI of the service. @param options [Array] filters to be applied to the HTTP requests.
# 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
Public Instance Methods
Check whether a domain is available.
@param subdomain_name [String] The subdomain name to use. @param type [String] The Type of the resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CheckDomainAvailabilityResult] operation results.
# 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 whether a domain is available.
@param subdomain_name [String] The subdomain name to use. @param type [String] The Type of the resource. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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 whether a domain is available.
@param subdomain_name [String] The subdomain name to use. @param type [String] The Type of the resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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 available SKUs.
@param location [String] Resource location. @param skus [Array<String>] The SKU of the resource. @param kind [String] The Kind of the resource. @param type [String] The Type of the resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CheckSkuAvailabilityResultList] operation results.
# 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 available SKUs.
@param location [String] Resource location. @param skus [Array<String>] The SKU of the resource. @param kind [String] The Kind of the resource. @param type [String] The Type of the resource. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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 available SKUs.
@param location [String] Resource location. @param skus [Array<String>] The SKU of the resource. @param kind [String] The Kind of the resource. @param type [String] The Type of the resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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
Makes a request and returns the body of the response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Hash{String=>String}] containing 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)
# 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
Makes a request asynchronously. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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
Makes a request and returns the operation response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.
# 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
Private Instance Methods
Adds telemetry information.
# File lib/2017-04-18/generated/azure_mgmt_cognitive_services/cognitive_services_management_client.rb, line 366 def add_telemetry sdk_information = 'azure_mgmt_cognitive_services' sdk_information = "#{sdk_information}/0.19.4" add_user_agent_information(sdk_information) end