Class: Azure::SQL::Mgmt::V2014_04_01::SqlManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2014-04-01/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.



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 166

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

  @server_advisors = ServerAdvisors.new(self)
  @database_advisors = DatabaseAdvisors.new(self)
  @backup_long_term_retention_policies = BackupLongTermRetentionPolicies.new(self)
  @backup_long_term_retention_vaults = BackupLongTermRetentionVaults.new(self)
  @recoverable_databases = RecoverableDatabases.new(self)
  @restorable_dropped_databases = RestorableDroppedDatabases.new(self)
  @capabilities = Capabilities.new(self)
  @servers = Servers.new(self)
  @server_connection_policies = ServerConnectionPolicies.new(self)
  @databases = Databases.new(self)
  @database_threat_detection_policies = DatabaseThreatDetectionPolicies.new(self)
  @data_masking_policies = DataMaskingPolicies.new(self)
  @data_masking_rules = DataMaskingRules.new(self)
  @transparent_data_encryption_configurations = TransparentDataEncryptionConfigurations.new(self)
  @extensions = Extensions.new(self)
  @disaster_recovery_configurations = DisasterRecoveryConfigurations.new(self)
  @elastic_pools = ElasticPools.new(self)
  @firewall_rules = FirewallRules.new(self)
  @geo_backup_policies = GeoBackupPolicies.new(self)
  @operations = Operations.new(self)
  @queries = Queries.new(self)
  @query_statistics = QueryStatistics.new(self)
  @query_texts = QueryTexts.new(self)
  @recommended_elastic_pools = RecommendedElasticPools.new(self)
  @replication_links = ReplicationLinks.new(self)
  @restore_points = RestorePoints.new(self)
  @server_azure_adadministrators = ServerAzureADAdministrators.new(self)
  @server_communication_links = ServerCommunicationLinks.new(self)
  @service_objectives = ServiceObjectives.new(self)
  @elastic_pool_activities = ElasticPoolActivities.new(self)
  @elastic_pool_database_activities = ElasticPoolDatabaseActivities.new(self)
  @service_tier_advisors = ServiceTierAdvisors.new(self)
  @transparent_data_encryptions = TransparentDataEncryptions.new(self)
  @transparent_data_encryption_activities = TransparentDataEncryptionActivities.new(self)
  @server_table_auditing_policies = ServerTableAuditingPolicies.new(self)
  @database_table_auditing_policies = DatabaseTableAuditingPolicies.new(self)
  @database_connection_policies = DatabaseConnectionPolicies.new(self)
  @server_usages = ServerUsages.new(self)
  @database_usages = DatabaseUsages.new(self)
  @api_version = '2014-04-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/2014-04-01/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.



21
22
23
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 21

def api_version
  @api_version
end

#backup_long_term_retention_policies ⇒ BackupLongTermRetentionPolicies (readonly)

backup_long_term_retention_policies

Returns:



47
48
49
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 47

def backup_long_term_retention_policies
  @backup_long_term_retention_policies
end

#backup_long_term_retention_vaults ⇒ BackupLongTermRetentionVaults (readonly)

Returns backup_long_term_retention_vaults.

Returns:



50
51
52
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 50

def backup_long_term_retention_vaults
  @backup_long_term_retention_vaults
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 15

def base_url
  @base_url
end

#capabilities ⇒ Capabilities (readonly)

Returns capabilities.

Returns:



59
60
61
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 59

def capabilities
  @capabilities
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/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 18

def credentials
  @credentials
end

#data_masking_policies ⇒ DataMaskingPolicies (readonly)

Returns data_masking_policies.

Returns:



75
76
77
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 75

def data_masking_policies
  @data_masking_policies
end

#data_masking_rules ⇒ DataMaskingRules (readonly)

Returns data_masking_rules.

Returns:



78
79
80
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 78

def data_masking_rules
  @data_masking_rules
end

#database_advisors ⇒ DatabaseAdvisors (readonly)

Returns database_advisors.

Returns:



43
44
45
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 43

def database_advisors
  @database_advisors
end

#database_connection_policies ⇒ DatabaseConnectionPolicies (readonly)

Returns database_connection_policies.

Returns:



152
153
154
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 152

def database_connection_policies
  @database_connection_policies
end

#database_table_auditing_policies ⇒ DatabaseTableAuditingPolicies (readonly)

Returns database_table_auditing_policies.

Returns:



149
150
151
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 149

def database_table_auditing_policies
  @database_table_auditing_policies
end

#database_threat_detection_policies ⇒ DatabaseThreatDetectionPolicies (readonly)

database_threat_detection_policies

Returns:



72
73
74
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 72

def database_threat_detection_policies
  @database_threat_detection_policies
end

#database_usages ⇒ DatabaseUsages (readonly)

Returns database_usages.

Returns:



158
159
160
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 158

def database_usages
  @database_usages
end

#databases ⇒ Databases (readonly)

Returns databases.

Returns:



68
69
70
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 68

def databases
  @databases
end

#disaster_recovery_configurations ⇒ DisasterRecoveryConfigurations (readonly)

Returns disaster_recovery_configurations.

Returns:



88
89
90
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 88

def disaster_recovery_configurations
  @disaster_recovery_configurations
end

#elastic_pool_activities ⇒ ElasticPoolActivities (readonly)

Returns elastic_pool_activities.

Returns:



130
131
132
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 130

def elastic_pool_activities
  @elastic_pool_activities
end

#elastic_pool_database_activities ⇒ ElasticPoolDatabaseActivities (readonly)

Returns elastic_pool_database_activities.

Returns:



133
134
135
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 133

def elastic_pool_database_activities
  @elastic_pool_database_activities
end

#elastic_pools ⇒ ElasticPools (readonly)

Returns elastic_pools.

Returns:



91
92
93
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 91

def elastic_pools
  @elastic_pools
end

#extensions ⇒ Extensions (readonly)

Returns extensions.

Returns:



85
86
87
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 85

def extensions
  @extensions
end

#firewall_rules ⇒ FirewallRules (readonly)

Returns firewall_rules.

Returns:



94
95
96
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 94

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/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 37

def generate_client_request_id
  @generate_client_request_id
end

#geo_backup_policies ⇒ GeoBackupPolicies (readonly)

Returns geo_backup_policies.

Returns:



97
98
99
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 97

def geo_backup_policies
  @geo_backup_policies
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/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 32

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



100
101
102
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 100

def operations
  @operations
end

#queries ⇒ Queries (readonly)

Returns queries.

Returns:



103
104
105
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 103

def queries
  @queries
end

#query_statistics ⇒ QueryStatistics (readonly)

Returns query_statistics.

Returns:



106
107
108
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 106

def query_statistics
  @query_statistics
end

#query_texts ⇒ QueryTexts (readonly)

Returns query_texts.

Returns:



109
110
111
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 109

def query_texts
  @query_texts
end

#recommended_elastic_pools ⇒ RecommendedElasticPools (readonly)

Returns recommended_elastic_pools.

Returns:



112
113
114
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 112

def recommended_elastic_pools
  @recommended_elastic_pools
end

#recoverable_databases ⇒ RecoverableDatabases (readonly)

Returns recoverable_databases.

Returns:



53
54
55
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 53

def recoverable_databases
  @recoverable_databases
end

#replication_links ⇒ ReplicationLinks (readonly)

Returns replication_links.

Returns:



115
116
117
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 115

def replication_links
  @replication_links
end

#restorable_dropped_databases ⇒ RestorableDroppedDatabases (readonly)

Returns restorable_dropped_databases.

Returns:



56
57
58
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 56

def restorable_dropped_databases
  @restorable_dropped_databases
end

#restore_points ⇒ RestorePoints (readonly)

Returns restore_points.

Returns:



118
119
120
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 118

def restore_points
  @restore_points
end

#server_advisors ⇒ ServerAdvisors (readonly)

Returns server_advisors.

Returns:



40
41
42
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 40

def server_advisors
  @server_advisors
end

#server_azure_adadministrators ⇒ ServerAzureADAdministrators (readonly)

Returns server_azure_adadministrators.

Returns:



121
122
123
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 121

def server_azure_adadministrators
  @server_azure_adadministrators
end

#server_communication_links ⇒ ServerCommunicationLinks (readonly)

Returns server_communication_links.

Returns:



124
125
126
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 124

def server_communication_links
  @server_communication_links
end

#server_connection_policies ⇒ ServerConnectionPolicies (readonly)

Returns server_connection_policies.

Returns:



65
66
67
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 65

def server_connection_policies
  @server_connection_policies
end

#server_table_auditing_policies ⇒ ServerTableAuditingPolicies (readonly)

Returns server_table_auditing_policies.

Returns:



146
147
148
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 146

def server_table_auditing_policies
  @server_table_auditing_policies
end

#server_usages ⇒ ServerUsages (readonly)

Returns server_usages.

Returns:



155
156
157
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 155

def server_usages
  @server_usages
end

#servers ⇒ Servers (readonly)

Returns servers.

Returns:



62
63
64
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 62

def servers
  @servers
end

#service_objectives ⇒ ServiceObjectives (readonly)

Returns service_objectives.

Returns:



127
128
129
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 127

def service_objectives
  @service_objectives
end

#service_tier_advisors ⇒ ServiceTierAdvisors (readonly)

Returns service_tier_advisors.

Returns:



136
137
138
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 136

def service_tier_advisors
  @service_tier_advisors
end

#subscription_id ⇒ String

subscription.

Returns:

  • (String) —

    The subscription ID that identifies an Azure



25
26
27
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 25

def subscription_id
  @subscription_id
end

#transparent_data_encryption_activities ⇒ TransparentDataEncryptionActivities (readonly)

transparent_data_encryption_activities

Returns:



143
144
145
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 143

def transparent_data_encryption_activities
  @transparent_data_encryption_activities
end

#transparent_data_encryption_configurations ⇒ TransparentDataEncryptionConfigurations (readonly)

transparent_data_encryption_configurations

Returns:



82
83
84
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 82

def transparent_data_encryption_configurations
  @transparent_data_encryption_configurations
end

#transparent_data_encryptions ⇒ TransparentDataEncryptions (readonly)

Returns transparent_data_encryptions.

Returns:



139
140
141
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 139

def transparent_data_encryptions
  @transparent_data_encryptions
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.



235
236
237
238
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 235

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.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 260

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.



247
248
249
250
251
 
# File 'lib/2014-04-01/generated/azure_mgmt_sql/sql_management_client.rb', line 247

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