Class: Azure::ARM::CognitiveServices::CheckSkuAvailability

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_cognitive_services/check_sku_availability.rb

Overview

Cognitive Services Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ CheckSkuAvailability

Creates and initializes a new instance of the CheckSkuAvailability class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/generated/azure_mgmt_cognitive_services/check_sku_availability.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CognitiveServicesManagementClient (readonly)

Returns reference to the CognitiveServicesManagementClient.

Returns:



22
23
24
 
# File 'lib/generated/azure_mgmt_cognitive_services/check_sku_availability.rb', line 22

def client
  @client
end

Instance Method Details

#list(location, skus, kind, type, custom_headers = nil) ⇒ CheckSkuAvailabilityResultList

Check available SKUs.

‘Academic’, ‘Bing.Autosuggest’, ‘Bing.Search’, ‘Bing.Speech’, ‘Bing.SpellCheck’, ‘ComputerVision’, ‘ContentModerator’, ‘CustomSpeech’, ‘Emotion’, ‘Face’, ‘LUIS’, ‘Recommendations’, ‘SpeakerRecognition’, ‘Speech’, ‘SpeechTranslation’, ‘TextAnalytics’, ‘TextTranslation’, ‘WebLM’ will be added to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • skus (Array<SkuName>) —

    The SKU of the resource.

  • kind (Kind) —

    The Kind of the resource. Possible values include:

  • 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.



40
41
42
43
 
# File 'lib/generated/azure_mgmt_cognitive_services/check_sku_availability.rb', line 40

def list(location, skus, kind, type, custom_headers = nil)
  response = list_async(location, skus, kind, type, custom_headers).value!
  response.body unless response.nil?
end

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

Check available SKUs.

‘Academic’, ‘Bing.Autosuggest’, ‘Bing.Search’, ‘Bing.Speech’, ‘Bing.SpellCheck’, ‘ComputerVision’, ‘ContentModerator’, ‘CustomSpeech’, ‘Emotion’, ‘Face’, ‘LUIS’, ‘Recommendations’, ‘SpeakerRecognition’, ‘Speech’, ‘SpeechTranslation’, ‘TextAnalytics’, ‘TextTranslation’, ‘WebLM’ to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • skus (Array<SkuName>) —

    The SKU of the resource.

  • kind (Kind) —

    The Kind of the resource. Possible values include:

  • 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.



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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/generated/azure_mgmt_cognitive_services/check_sku_availability.rb', line 81

def list_async(location, skus, kind, type, custom_headers = nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  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 = CheckSkuAvailabilityParameter.new
  unless skus.nil? && kind.nil? && type.nil?
    parameters.skus = skus
    parameters.kind = kind
    parameters.type = type
  end

  request_headers = {}

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

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

  # Serialize Request
  request_mapper = Azure::ARM::CognitiveServices::Models::CheckSkuAvailabilityParameter.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.CognitiveServices/locations/{location}/checkSkuAvailability'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'location' => location},
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::CognitiveServices::Models::CheckSkuAvailabilityResultList.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_with_http_info(location, skus, kind, type, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Check available SKUs.

‘Academic’, ‘Bing.Autosuggest’, ‘Bing.Search’, ‘Bing.Speech’, ‘Bing.SpellCheck’, ‘ComputerVision’, ‘ContentModerator’, ‘CustomSpeech’, ‘Emotion’, ‘Face’, ‘LUIS’, ‘Recommendations’, ‘SpeakerRecognition’, ‘Speech’, ‘SpeechTranslation’, ‘TextAnalytics’, ‘TextTranslation’, ‘WebLM’ will be added to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • skus (Array<SkuName>) —

    The SKU of the resource.

  • kind (Kind) —

    The Kind of the resource. Possible values include:

  • 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.



61
62
63
 
# File 'lib/generated/azure_mgmt_cognitive_services/check_sku_availability.rb', line 61

def list_with_http_info(location, skus, kind, type, custom_headers = nil)
  list_async(location, skus, kind, type, custom_headers).value!
end