Class: Azure::SQL::Mgmt::V2018_06_01_preview::SqlManagementClient

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 80

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_columns = DatabaseColumns.new(self)
  @database_schemas = DatabaseSchemas.new(self)
  @database_tables = DatabaseTables.new(self)
  @database_security_alert_policies = DatabaseSecurityAlertPolicies.new(self)
  @managed_database_columns = ManagedDatabaseColumns.new(self)
  @managed_database_schemas = ManagedDatabaseSchemas.new(self)
  @managed_database_tables = ManagedDatabaseTables.new(self)
  @managed_instance_vulnerability_assessments = ManagedInstanceVulnerabilityAssessments.new(self)
  @server_vulnerability_assessments = ServerVulnerabilityAssessments.new(self)
  @instance_pools = InstancePools.new(self)
  @managed_database_sensitivity_labels = ManagedDatabaseSensitivityLabels.new(self)
  @api_version = '2018-06-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/2018-06-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/2018-06-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/2018-06-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/2018-06-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 18

def credentials
  @credentials
end

#database_columns ⇒ DatabaseColumns (readonly)

Returns database_columns.

Returns:



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

def database_columns
  @database_columns
end

#database_schemas ⇒ DatabaseSchemas (readonly)

Returns database_schemas.

Returns:



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

def database_schemas
  @database_schemas
end

#database_security_alert_policies ⇒ DatabaseSecurityAlertPolicies (readonly)

Returns database_security_alert_policies.

Returns:



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

def database_security_alert_policies
  @database_security_alert_policies
end

#database_tables ⇒ DatabaseTables (readonly)

Returns database_tables.

Returns:



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

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

def generate_client_request_id
  @generate_client_request_id
end

#instance_pools ⇒ InstancePools (readonly)

Returns instance_pools.

Returns:



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

def instance_pools
  @instance_pools
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/2018-06-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_columns ⇒ ManagedDatabaseColumns (readonly)

Returns managed_database_columns.

Returns:



52
53
54
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 52

def managed_database_columns
  @managed_database_columns
end

#managed_database_schemas ⇒ ManagedDatabaseSchemas (readonly)

Returns managed_database_schemas.

Returns:



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

def managed_database_schemas
  @managed_database_schemas
end

#managed_database_sensitivity_labels ⇒ ManagedDatabaseSensitivityLabels (readonly)

managed_database_sensitivity_labels

Returns:



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

def managed_database_sensitivity_labels
  @managed_database_sensitivity_labels
end

#managed_database_tables ⇒ ManagedDatabaseTables (readonly)

Returns managed_database_tables.

Returns:



58
59
60
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 58

def managed_database_tables
  @managed_database_tables
end

#managed_instance_vulnerability_assessments ⇒ ManagedInstanceVulnerabilityAssessments (readonly)

managed_instance_vulnerability_assessments

Returns:



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

def managed_instance_vulnerability_assessments
  @managed_instance_vulnerability_assessments
end

#server_vulnerability_assessments ⇒ ServerVulnerabilityAssessments (readonly)

Returns server_vulnerability_assessments.

Returns:



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

def server_vulnerability_assessments
  @server_vulnerability_assessments
end

#subscription_id ⇒ String

subscription.

Returns:

  • (String) —

    The subscription ID that identifies an Azure



22
23
24
 
# File 'lib/2018-06-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.



121
122
123
124
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 121

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.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 146

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.



133
134
135
136
137
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_sql/sql_management_client.rb', line 133

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