Class: Azure::SQL::Mgmt::V2017_03_01_preview::SqlManagementClient

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



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
197
198
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 154

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

  @extended_database_blob_auditing_policies = ExtendedDatabaseBlobAuditingPolicies.new(self)
  @extended_server_blob_auditing_policies = ExtendedServerBlobAuditingPolicies.new(self)
  @server_blob_auditing_policies = ServerBlobAuditingPolicies.new(self)
  @database_blob_auditing_policies = DatabaseBlobAuditingPolicies.new(self)
  @database_operations = DatabaseOperations.new(self)
  @databases = Databases.new(self)
  @database_vulnerability_assessment_rule_baselines = DatabaseVulnerabilityAssessmentRuleBaselines.new(self)
  @database_vulnerability_assessments = DatabaseVulnerabilityAssessments.new(self)
  @data_warehouse_user_activities_operations = DataWarehouseUserActivitiesOperations.new(self)
  @job_agents = JobAgents.new(self)
  @job_credentials = JobCredentials.new(self)
  @job_executions = JobExecutions.new(self)
  @jobs = Jobs.new(self)
  @job_step_executions = JobStepExecutions.new(self)
  @job_steps = JobSteps.new(self)
  @job_target_executions = JobTargetExecutions.new(self)
  @job_target_groups = JobTargetGroups.new(self)
  @job_versions = JobVersions.new(self)
  @long_term_retention_backups = LongTermRetentionBackups.new(self)
  @backup_long_term_retention_policies = BackupLongTermRetentionPolicies.new(self)
  @managed_backup_short_term_retention_policies = ManagedBackupShortTermRetentionPolicies.new(self)
  @managed_databases = ManagedDatabases.new(self)
  @managed_restorable_dropped_database_backup_short_term_retention_policies = ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies.new(self)
  @restorable_dropped_managed_databases = RestorableDroppedManagedDatabases.new(self)
  @restore_points = RestorePoints.new(self)
  @server_automatic_tuning_operations = ServerAutomaticTuningOperations.new(self)
  @server_dns_aliases = ServerDnsAliases.new(self)
  @server_security_alert_policies = ServerSecurityAlertPolicies.new(self)
  @managed_database_security_alert_policies = ManagedDatabaseSecurityAlertPolicies.new(self)
  @managed_server_security_alert_policies = ManagedServerSecurityAlertPolicies.new(self)
  @sensitivity_labels = SensitivityLabels.new(self)
  @managed_instance_administrators = ManagedInstanceAdministrators.new(self)
  @api_version = '2017-03-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/2017-03-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/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 25

def api_version
  @api_version
end

#backup_long_term_retention_policies ⇒ BackupLongTermRetentionPolicies (readonly)

backup_long_term_retention_policies

Returns:



103
104
105
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 103

def backup_long_term_retention_policies
  @backup_long_term_retention_policies
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-03-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/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 18

def credentials
  @credentials
end

#data_warehouse_user_activities_operations ⇒ DataWarehouseUserActivitiesOperations (readonly)

data_warehouse_user_activities_operations

Returns:



69
70
71
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 69

def data_warehouse_user_activities_operations
  @data_warehouse_user_activities_operations
end

#database_blob_auditing_policies ⇒ DatabaseBlobAuditingPolicies (readonly)

Returns database_blob_auditing_policies.

Returns:



51
52
53
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 51

def database_blob_auditing_policies
  @database_blob_auditing_policies
end

#database_operations ⇒ DatabaseOperations (readonly)

Returns database_operations.

Returns:



54
55
56
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 54

def database_operations
  @database_operations
end

#database_vulnerability_assessment_rule_baselines ⇒ DatabaseVulnerabilityAssessmentRuleBaselines (readonly)

database_vulnerability_assessment_rule_baselines

Returns:



61
62
63
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 61

def database_vulnerability_assessment_rule_baselines
  @database_vulnerability_assessment_rule_baselines
end

#database_vulnerability_assessments ⇒ DatabaseVulnerabilityAssessments (readonly)

database_vulnerability_assessments

Returns:



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

def database_vulnerability_assessments
  @database_vulnerability_assessments
end

#databases ⇒ Databases (readonly)

Returns databases.

Returns:



57
58
59
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 57

def databases
  @databases
end

#extended_database_blob_auditing_policies ⇒ ExtendedDatabaseBlobAuditingPolicies (readonly)

extended_database_blob_auditing_policies

Returns:



41
42
43
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 41

def extended_database_blob_auditing_policies
  @extended_database_blob_auditing_policies
end

#extended_server_blob_auditing_policies ⇒ ExtendedServerBlobAuditingPolicies (readonly)

extended_server_blob_auditing_policies

Returns:



45
46
47
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 45

def extended_server_blob_auditing_policies
  @extended_server_blob_auditing_policies
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-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 37

def generate_client_request_id
  @generate_client_request_id
end

#job_agents ⇒ JobAgents (readonly)

Returns job_agents.

Returns:



72
73
74
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 72

def job_agents
  @job_agents
end

#job_credentials ⇒ JobCredentials (readonly)

Returns job_credentials.

Returns:



75
76
77
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 75

def job_credentials
  @job_credentials
end

#job_executions ⇒ JobExecutions (readonly)

Returns job_executions.

Returns:



78
79
80
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 78

def job_executions
  @job_executions
end

#job_step_executions ⇒ JobStepExecutions (readonly)

Returns job_step_executions.

Returns:



84
85
86
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 84

def job_step_executions
  @job_step_executions
end

#job_steps ⇒ JobSteps (readonly)

Returns job_steps.

Returns:



87
88
89
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 87

def job_steps
  @job_steps
end

#job_target_executions ⇒ JobTargetExecutions (readonly)

Returns job_target_executions.

Returns:



90
91
92
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 90

def job_target_executions
  @job_target_executions
end

#job_target_groups ⇒ JobTargetGroups (readonly)

Returns job_target_groups.

Returns:



93
94
95
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 93

def job_target_groups
  @job_target_groups
end

#job_versions ⇒ JobVersions (readonly)

Returns job_versions.

Returns:



96
97
98
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 96

def job_versions
  @job_versions
end

#jobs ⇒ Jobs (readonly)

Returns jobs.

Returns:



81
82
83
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 81

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

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#long_term_retention_backups ⇒ LongTermRetentionBackups (readonly)

Returns long_term_retention_backups.

Returns:



99
100
101
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 99

def long_term_retention_backups
  @long_term_retention_backups
end

#managed_backup_short_term_retention_policies ⇒ ManagedBackupShortTermRetentionPolicies (readonly)

managed_backup_short_term_retention_policies

Returns:



107
108
109
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 107

def managed_backup_short_term_retention_policies
  @managed_backup_short_term_retention_policies
end

#managed_database_security_alert_policies ⇒ ManagedDatabaseSecurityAlertPolicies (readonly)

managed_database_security_alert_policies

Returns:



136
137
138
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 136

def managed_database_security_alert_policies
  @managed_database_security_alert_policies
end

#managed_databases ⇒ ManagedDatabases (readonly)

Returns managed_databases.

Returns:



110
111
112
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 110

def managed_databases
  @managed_databases
end

#managed_instance_administrators ⇒ ManagedInstanceAdministrators (readonly)

Returns managed_instance_administrators.

Returns:



146
147
148
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 146

def managed_instance_administrators
  @managed_instance_administrators
end

#managed_restorable_dropped_database_backup_short_term_retention_policies ⇒ Object (readonly)

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies

managed_restorable_dropped_database_backup_short_term_retention_policies

Returns:



115
116
117
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 115

def managed_restorable_dropped_database_backup_short_term_retention_policies
  @managed_restorable_dropped_database_backup_short_term_retention_policies
end

#managed_server_security_alert_policies ⇒ ManagedServerSecurityAlertPolicies (readonly)

managed_server_security_alert_policies

Returns:



140
141
142
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 140

def managed_server_security_alert_policies
  @managed_server_security_alert_policies
end

#restorable_dropped_managed_databases ⇒ RestorableDroppedManagedDatabases (readonly)

restorable_dropped_managed_databases

Returns:



119
120
121
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 119

def restorable_dropped_managed_databases
  @restorable_dropped_managed_databases
end

#restore_points ⇒ RestorePoints (readonly)

Returns restore_points.

Returns:



122
123
124
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 122

def restore_points
  @restore_points
end

#sensitivity_labels ⇒ SensitivityLabels (readonly)

Returns sensitivity_labels.

Returns:



143
144
145
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 143

def sensitivity_labels
  @sensitivity_labels
end

#server_automatic_tuning_operations ⇒ ServerAutomaticTuningOperations (readonly)

server_automatic_tuning_operations

Returns:



126
127
128
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 126

def server_automatic_tuning_operations
  @server_automatic_tuning_operations
end

#server_blob_auditing_policies ⇒ ServerBlobAuditingPolicies (readonly)

Returns server_blob_auditing_policies.

Returns:



48
49
50
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 48

def server_blob_auditing_policies
  @server_blob_auditing_policies
end

#server_dns_aliases ⇒ ServerDnsAliases (readonly)

Returns server_dns_aliases.

Returns:



129
130
131
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 129

def server_dns_aliases
  @server_dns_aliases
end

#server_security_alert_policies ⇒ ServerSecurityAlertPolicies (readonly)

Returns server_security_alert_policies.

Returns:



132
133
134
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 132

def server_security_alert_policies
  @server_security_alert_policies
end

#subscription_id ⇒ String

subscription.

Returns:

  • (String) —

    The subscription ID that identifies an Azure



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

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



216
217
218
219
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 216

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.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 241

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.



228
229
230
231
232
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 228

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