Class: Azure::Mysql::Mgmt::V2017_12_01::MySQLManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_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) ⇒ MySQLManagementClient

Creates initializes a new instance of the MySQLManagementClient 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.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 78

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

  @servers = Servers.new(self)
  @replicas = Replicas.new(self)
  @firewall_rules = FirewallRules.new(self)
  @virtual_network_rules = VirtualNetworkRules.new(self)
  @databases = Databases.new(self)
  @configurations = Configurations.new(self)
  @log_files = LogFiles.new(self)
  @location_based_performance_tier = LocationBasedPerformanceTier.new(self)
  @check_name_availability = CheckNameAvailability.new(self)
  @server_security_alert_policies = ServerSecurityAlertPolicies.new(self)
  @operations = Operations.new(self)
  @api_version = '2017-12-01'
  @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.



28
29
30
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 28

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns The API version to use for the request.

Returns:

  • (String) —

    The API version to use for the request.



25
26
27
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 25

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-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 15

def base_url
  @base_url
end

#check_name_availability ⇒ CheckNameAvailability (readonly)

Returns check_name_availability.

Returns:



64
65
66
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 64

def check_name_availability
  @check_name_availability
end

#configurations ⇒ Configurations (readonly)

Returns configurations.

Returns:



55
56
57
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 55

def configurations
  @configurations
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-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 18

def credentials
  @credentials
end

#databases ⇒ Databases (readonly)

Returns databases.

Returns:



52
53
54
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 52

def databases
  @databases
end

#firewall_rules ⇒ FirewallRules (readonly)

Returns firewall_rules.

Returns:



46
47
48
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 46

def firewall_rules
  @firewall_rules
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



37
38
39
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 37

def generate_client_request_id
  @generate_client_request_id
end

#location_based_performance_tier ⇒ LocationBasedPerformanceTier (readonly)

Returns location_based_performance_tier.

Returns:



61
62
63
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 61

def location_based_performance_tier
  @location_based_performance_tier
end

#log_files ⇒ LogFiles (readonly)

Returns log_files.

Returns:



58
59
60
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 58

def log_files
  @log_files
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



32
33
34
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 32

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



70
71
72
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 70

def operations
  @operations
end

#replicas ⇒ Replicas (readonly)

Returns replicas.

Returns:



43
44
45
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 43

def replicas
  @replicas
end

#server_security_alert_policies ⇒ ServerSecurityAlertPolicies (readonly)

Returns server_security_alert_policies.

Returns:



67
68
69
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 67

def server_security_alert_policies
  @server_security_alert_policies
end

#servers ⇒ Servers (readonly)

Returns servers.

Returns:



40
41
42
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 40

def servers
  @servers
end

#subscription_id ⇒ String

subscription.

Returns:

  • (String) —

    The subscription ID that identifies an Azure



22
23
24
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 22

def subscription_id
  @subscription_id
end

#virtual_network_rules ⇒ VirtualNetworkRules (readonly)

Returns virtual_network_rules.

Returns:



49
50
51
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 49

def virtual_network_rules
  @virtual_network_rules
end

Instance Method Details

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



119
120
121
122
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 119

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.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 144

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.



131
132
133
134
135
 
# File 'lib/2017-12-01/generated/azure_mgmt_mysql/my_sqlmanagement_client.rb', line 131

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