Class: Azure::SQL::Mgmt::V2017_10_01_preview::SqlManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2017-10-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
 
# File 'lib/2017-10-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_operations = DatabaseOperations.new(self)
  @elastic_pool_operations = ElasticPoolOperations.new(self)
  @database_vulnerability_assessment_scans = DatabaseVulnerabilityAssessmentScans.new(self)
  @managed_database_vulnerability_assessment_rule_baselines = ManagedDatabaseVulnerabilityAssessmentRuleBaselines.new(self)
  @managed_database_vulnerability_assessment_scans = ManagedDatabaseVulnerabilityAssessmentScans.new(self)
  @managed_database_vulnerability_assessments = ManagedDatabaseVulnerabilityAssessments.new(self)
  @capabilities = Capabilities.new(self)
  @databases = Databases.new(self)
  @elastic_pools = ElasticPools.new(self)
  @instance_failover_groups = InstanceFailoverGroups.new(self)
  @backup_short_term_retention_policies = BackupShortTermRetentionPolicies.new(self)
  @tde_certificates = TdeCertificates.new(self)
  @managed_instance_tde_certificates = ManagedInstanceTdeCertificates.new(self)
  @managed_instance_keys = ManagedInstanceKeys.new(self)
  @managed_instance_encryption_protectors = ManagedInstanceEncryptionProtectors.new(self)
  @recoverable_managed_databases = RecoverableManagedDatabases.new(self)
  @api_version = '2017-10-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-10-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-10-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 25

def api_version
  @api_version
end

#backup_short_term_retention_policies ⇒ BackupShortTermRetentionPolicies (readonly)

backup_short_term_retention_policies

Returns:



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

def backup_short_term_retention_policies
  @backup_short_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-10-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 15

def base_url
  @base_url
end

#capabilities ⇒ Capabilities (readonly)

Returns capabilities.

Returns:



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

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

def credentials
  @credentials
end

#database_operations ⇒ DatabaseOperations (readonly)

Returns database_operations.

Returns:



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

def database_operations
  @database_operations
end

#database_vulnerability_assessment_scans ⇒ DatabaseVulnerabilityAssessmentScans (readonly)

database_vulnerability_assessment_scans

Returns:



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

def database_vulnerability_assessment_scans
  @database_vulnerability_assessment_scans
end

#databases ⇒ Databases (readonly)

Returns databases.

Returns:



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

def databases
  @databases
end

#elastic_pool_operations ⇒ ElasticPoolOperations (readonly)

Returns elastic_pool_operations.

Returns:



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

def elastic_pool_operations
  @elastic_pool_operations
end

#elastic_pools ⇒ ElasticPools (readonly)

Returns elastic_pools.

Returns:



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

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

def generate_client_request_id
  @generate_client_request_id
end

#instance_failover_groups ⇒ InstanceFailoverGroups (readonly)

Returns instance_failover_groups.

Returns:



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

def instance_failover_groups
  @instance_failover_groups
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-10-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_database_vulnerability_assessment_rule_baselines ⇒ ManagedDatabaseVulnerabilityAssessmentRuleBaselines (readonly)

managed_database_vulnerability_assessment_rule_baselines

Returns:



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

def managed_database_vulnerability_assessment_rule_baselines
  @managed_database_vulnerability_assessment_rule_baselines
end

#managed_database_vulnerability_assessment_scans ⇒ ManagedDatabaseVulnerabilityAssessmentScans (readonly)

managed_database_vulnerability_assessment_scans

Returns:



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

def managed_database_vulnerability_assessment_scans
  @managed_database_vulnerability_assessment_scans
end

#managed_database_vulnerability_assessments ⇒ ManagedDatabaseVulnerabilityAssessments (readonly)

managed_database_vulnerability_assessments

Returns:



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

def managed_database_vulnerability_assessments
  @managed_database_vulnerability_assessments
end

#managed_instance_encryption_protectors ⇒ ManagedInstanceEncryptionProtectors (readonly)

managed_instance_encryption_protectors

Returns:



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

def managed_instance_encryption_protectors
  @managed_instance_encryption_protectors
end

#managed_instance_keys ⇒ ManagedInstanceKeys (readonly)

Returns managed_instance_keys.

Returns:



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

def managed_instance_keys
  @managed_instance_keys
end

#managed_instance_tde_certificates ⇒ ManagedInstanceTdeCertificates (readonly)

managed_instance_tde_certificates

Returns:



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

def managed_instance_tde_certificates
  @managed_instance_tde_certificates
end

#recoverable_managed_databases ⇒ RecoverableManagedDatabases (readonly)

Returns recoverable_managed_databases.

Returns:



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

def recoverable_managed_databases
  @recoverable_managed_databases
end

#subscription_id ⇒ String

subscription.

Returns:

  • (String) —

    The subscription ID that identifies an Azure



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

def subscription_id
  @subscription_id
end

#tde_certificates ⇒ TdeCertificates (readonly)

Returns tde_certificates.

Returns:



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

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



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

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.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 171

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.



158
159
160
161
162
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 158

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