Class: Azure::MariaDB::Mgmt::V2020_01_01::Servers

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb

Overview

The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MariaDB resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Servers

Creates and initializes a new instance of the Servers class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ MariaDBManagementClient (readonly)

Returns reference to the MariaDBManagementClient.

Returns:



25
26
27
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 25

def client
  @client
end

Instance Method Details

#begin_start(resource_group_name, server_name, custom_headers: nil) ⇒ Object

Starts a stopped server.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that



117
118
119
120
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 117

def begin_start(resource_group_name, server_name, custom_headers:nil)
  response = begin_start_async(resource_group_name, server_name, custom_headers:custom_headers).value!
  nil
end

#begin_start_async(resource_group_name, server_name, custom_headers: nil) ⇒ Concurrent::Promise

Starts a stopped server.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
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
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 148

def begin_start_async(resource_group_name, server_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'server_name is nil' if server_name.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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/start'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'serverName' => server_name},
      query_params: {'api-version' => @client.api_version},
      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 || status_code == 202
      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?

    result
  end

  promise.execute
end

#begin_start_with_http_info(resource_group_name, server_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Starts a stopped server.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



133
134
135
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 133

def begin_start_with_http_info(resource_group_name, server_name, custom_headers:nil)
  begin_start_async(resource_group_name, server_name, custom_headers:custom_headers).value!
end

#begin_stop(resource_group_name, server_name, custom_headers: nil) ⇒ Object

Stops a running server.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that



208
209
210
211
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 208

def begin_stop(resource_group_name, server_name, custom_headers:nil)
  response = begin_stop_async(resource_group_name, server_name, custom_headers:custom_headers).value!
  nil
end

#begin_stop_async(resource_group_name, server_name, custom_headers: nil) ⇒ Concurrent::Promise

Stops a running server.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
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
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 239

def begin_stop_async(resource_group_name, server_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'server_name is nil' if server_name.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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/stop'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'serverName' => server_name},
      query_params: {'api-version' => @client.api_version},
      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 || status_code == 202
      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?

    result
  end

  promise.execute
end

#begin_stop_with_http_info(resource_group_name, server_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Stops a running server.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



224
225
226
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 224

def begin_stop_with_http_info(resource_group_name, server_name, custom_headers:nil)
  begin_stop_async(resource_group_name, server_name, custom_headers:custom_headers).value!
end

#start(resource_group_name, server_name, custom_headers: nil) ⇒ Object

Starts a stopped server.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that



36
37
38
39
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 36

def start(resource_group_name, server_name, custom_headers:nil)
  response = start_async(resource_group_name, server_name, custom_headers:custom_headers).value!
  nil
end

#start_async(resource_group_name, server_name, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 51

def start_async(resource_group_name, server_name, custom_headers:nil)
  # Send request
  promise = begin_start_async(resource_group_name, server_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#stop(resource_group_name, server_name, custom_headers: nil) ⇒ Object

Stops a running server.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that



76
77
78
79
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 76

def stop(resource_group_name, server_name, custom_headers:nil)
  response = stop_async(resource_group_name, server_name, custom_headers:custom_headers).value!
  nil
end

#stop_async(resource_group_name, server_name, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/2020-01-01/generated/azure_mgmt_mariadb/servers.rb', line 91

def stop_async(resource_group_name, server_name, custom_headers:nil)
  # Send request
  promise = begin_stop_async(resource_group_name, server_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end