Class: Azure::SQL::Mgmt::V2015_05_01_preview::SqlManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_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) ⇒ SqlManagementClient

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



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
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 100

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

  @database_advisors = DatabaseAdvisors.new(self)
  @database_recommended_actions = DatabaseRecommendedActions.new(self)
  @server_advisors = ServerAdvisors.new(self)
  @database_blob_auditing_policies = DatabaseBlobAuditingPolicies.new(self)
  @database_automatic_tuning_operations = DatabaseAutomaticTuningOperations.new(self)
  @encryption_protectors = EncryptionProtectors.new(self)
  @failover_groups = FailoverGroups.new(self)
  @firewall_rules = FirewallRules.new(self)
  @managed_instances = ManagedInstances.new(self)
  @operations = Operations.new(self)
  @server_keys = ServerKeys.new(self)
  @servers = Servers.new(self)
  @sync_agents = SyncAgents.new(self)
  @sync_groups = SyncGroups.new(self)
  @sync_members = SyncMembers.new(self)
  @subscription_usages = SubscriptionUsages.new(self)
  @virtual_clusters = VirtualClusters.new(self)
  @virtual_network_rules = VirtualNetworkRules.new(self)
  @api_version = '2015-05-01-preview'
  @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/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_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/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_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/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 15

def base_url
  @base_url
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/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 18

def credentials
  @credentials
end

#database_advisors ⇒ DatabaseAdvisors (readonly)

Returns database_advisors.

Returns:



40
41
42
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 40

def database_advisors
  @database_advisors
end

#database_automatic_tuning_operations ⇒ DatabaseAutomaticTuningOperations (readonly)

database_automatic_tuning_operations

Returns:



53
54
55
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 53

def database_automatic_tuning_operations
  @database_automatic_tuning_operations
end

#database_blob_auditing_policies ⇒ DatabaseBlobAuditingPolicies (readonly)

Returns database_blob_auditing_policies.

Returns:



49
50
51
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 49

def database_blob_auditing_policies
  @database_blob_auditing_policies
end

#database_recommended_actions ⇒ DatabaseRecommendedActions (readonly)

Returns database_recommended_actions.

Returns:



43
44
45
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 43

def database_recommended_actions
  @database_recommended_actions
end

#encryption_protectors ⇒ EncryptionProtectors (readonly)

Returns encryption_protectors.

Returns:



56
57
58
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 56

def encryption_protectors
  @encryption_protectors
end

#failover_groups ⇒ FailoverGroups (readonly)

Returns failover_groups.

Returns:



59
60
61
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 59

def failover_groups
  @failover_groups
end

#firewall_rules ⇒ FirewallRules (readonly)

Returns firewall_rules.

Returns:



62
63
64
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 62

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/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 37

def generate_client_request_id
  @generate_client_request_id
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/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 32

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#managed_instances ⇒ ManagedInstances (readonly)

Returns managed_instances.

Returns:



65
66
67
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 65

def managed_instances
  @managed_instances
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



68
69
70
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 68

def operations
  @operations
end

#server_advisors ⇒ ServerAdvisors (readonly)

Returns server_advisors.

Returns:



46
47
48
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 46

def server_advisors
  @server_advisors
end

#server_keys ⇒ ServerKeys (readonly)

Returns server_keys.

Returns:



71
72
73
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 71

def server_keys
  @server_keys
end

#servers ⇒ Servers (readonly)

Returns servers.

Returns:



74
75
76
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 74

def servers
  @servers
end

#subscription_id ⇒ String

subscription.

Returns:

  • (String) —

    The subscription ID that identifies an Azure



22
23
24
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 22

def subscription_id
  @subscription_id
end

#subscription_usages ⇒ SubscriptionUsages (readonly)

Returns subscription_usages.

Returns:



86
87
88
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 86

def subscription_usages
  @subscription_usages
end

#sync_agents ⇒ SyncAgents (readonly)

Returns sync_agents.

Returns:



77
78
79
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 77

def sync_agents
  @sync_agents
end

#sync_groups ⇒ SyncGroups (readonly)

Returns sync_groups.

Returns:



80
81
82
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 80

def sync_groups
  @sync_groups
end

#sync_members ⇒ SyncMembers (readonly)

Returns sync_members.

Returns:



83
84
85
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 83

def sync_members
  @sync_members
end

#virtual_clusters ⇒ VirtualClusters (readonly)

Returns virtual_clusters.

Returns:



89
90
91
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 89

def virtual_clusters
  @virtual_clusters
end

#virtual_network_rules ⇒ VirtualNetworkRules (readonly)

Returns virtual_network_rules.

Returns:



92
93
94
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 92

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.



148
149
150
151
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 148

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.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 173

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.



160
161
162
163
164
 
# File 'lib/2015-05-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 160

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