Class: Azure::Appconfiguration::Mgmt::V2019_02_01_preview::Operations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb

Overview

Operations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Operations

Creates and initializes a new instance of the Operations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ AppConfigurationManagementClient (readonly)

Returns reference to the AppConfigurationManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 22

def client
  @client
end

Instance Method Details

#check_name_availability(check_name_availability_parameters, custom_headers: nil) ⇒ NameAvailabilityStatus

Checks whether the configuration store name is available for use.

The object containing information for the availability request. will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (NameAvailabilityStatus) —

    operation results.



34
35
36
37
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 34

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

#check_name_availability_async(check_name_availability_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Checks whether the configuration store name is available for use.

The object containing information for the availability request. to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



63
64
65
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
119
120
121
122
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 63

def check_name_availability_async(check_name_availability_parameters, 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, 'check_name_availability_parameters is nil' if check_name_availability_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::Appconfiguration::Mgmt::V2019_02_01_preview::Models::CheckNameAvailabilityParameters.mapper()
  request_content = @client.serialize(request_mapper,  check_name_availability_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/checkNameAvailability'

  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},
      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 MsRest::HttpOperationError.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::Appconfiguration::Mgmt::V2019_02_01_preview::Models::NameAvailabilityStatus.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(check_name_availability_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Checks whether the configuration store name is available for use.

The object containing information for the availability request. will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



49
50
51
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 49

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

#list(skip_token: nil, custom_headers: nil) ⇒ Array<OperationDefinition>

Lists the operations available from this provider.

after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. will be added to the HTTP request.

Parameters:

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

    A skip token is used to continue retrieving items

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

    A hash of custom headers that

Returns:

  • (Array<OperationDefinition>) —

    operation results.



137
138
139
140
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 137

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

#list_as_lazy(skip_token: nil, custom_headers: nil) ⇒ OperationDefinitionListResult

Lists the operations available from this provider.

after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. will be added to the HTTP request.

the response.

Parameters:

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

    A skip token is used to continue retrieving items

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

    A hash of custom headers that

Returns:

  • (OperationDefinitionListResult) —

    which provide lazy access to pages of



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 327

def list_as_lazy(skip_token:nil, custom_headers:nil)
  response = list_async(skip_token:skip_token, 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(skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the operations available from this provider.

after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. to the HTTP request.

Parameters:

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

    A skip token is used to continue retrieving items

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 172

def list_async(skip_token:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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 = 'providers/Microsoft.AppConfiguration/operations'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => @client.api_version,'$skipToken' => skip_token},
      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 MsRest::HttpOperationError.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::Appconfiguration::Mgmt::V2019_02_01_preview::Models::OperationDefinitionListResult.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(next_page_link, custom_headers: nil) ⇒ OperationDefinitionListResult

Lists the operations available from this provider.

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:

  • (OperationDefinitionListResult) —

    operation results.



233
234
235
236
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 233

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

Lists the operations available from this provider.

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.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
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
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 262

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 MsRest::HttpOperationError.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::Appconfiguration::Mgmt::V2019_02_01_preview::Models::OperationDefinitionListResult.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

Lists the operations available from this provider.

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.



248
249
250
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 248

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(skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the operations available from this provider.

after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. will be added to the HTTP request.

Parameters:

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

    A skip token is used to continue retrieving items

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



155
156
157
 
# File 'lib/2019-02-01-preview/generated/azure_mgmt_appconfiguration/operations.rb', line 155

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