Class: Azure::ARM::SQL::SqlManagementClient

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



152
153
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
199
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 152

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

  @backup_long_term_retention_policies = BackupLongTermRetentionPolicies.new(self)
  @backup_long_term_retention_vaults = BackupLongTermRetentionVaults.new(self)
  @restore_points = RestorePoints.new(self)
  @recoverable_databases = RecoverableDatabases.new(self)
  @restorable_dropped_databases = RestorableDroppedDatabases.new(self)
  @capabilities = Capabilities.new(self)
  @server_connection_policies = ServerConnectionPolicies.new(self)
  @database_threat_detection_policies = DatabaseThreatDetectionPolicies.new(self)
  @data_masking_policies = DataMaskingPolicies.new(self)
  @data_masking_rules = DataMaskingRules.new(self)
  @firewall_rules = FirewallRules.new(self)
  @geo_backup_policies = GeoBackupPolicies.new(self)
  @databases = Databases.new(self)
  @elastic_pools = ElasticPools.new(self)
  @replication_links = ReplicationLinks.new(self)
  @server_azure_adadministrators = ServerAzureADAdministrators.new(self)
  @server_communication_links = ServerCommunicationLinks.new(self)
  @service_objectives = ServiceObjectives.new(self)
  @servers = Servers.new(self)
  @elastic_pool_activities = ElasticPoolActivities.new(self)
  @elastic_pool_database_activities = ElasticPoolDatabaseActivities.new(self)
  @recommended_elastic_pools = RecommendedElasticPools.new(self)
  @service_tier_advisors = ServiceTierAdvisors.new(self)
  @transparent_data_encryptions = TransparentDataEncryptions.new(self)
  @transparent_data_encryption_activities = TransparentDataEncryptionActivities.new(self)
  @server_usages = ServerUsages.new(self)
  @database_usages = DatabaseUsages.new(self)
  @database_blob_auditing_policies = DatabaseBlobAuditingPolicies.new(self)
  @encryption_protectors = EncryptionProtectors.new(self)
  @failover_groups = FailoverGroups.new(self)
  @operations = Operations.new(self)
  @server_keys = ServerKeys.new(self)
  @sync_agents = SyncAgents.new(self)
  @sync_groups = SyncGroups.new(self)
  @sync_members = SyncMembers.new(self)
  @virtual_network_rules = VirtualNetworkRules.new(self)
  @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 Gets or sets the preferred language for the response.

Returns:

  • (String) —

    Gets or sets the preferred language for the response.



25
26
27
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 25

def accept_language
  @accept_language
end

#backup_long_term_retention_policies ⇒ BackupLongTermRetentionPolicies (readonly)

backup_long_term_retention_policies

Returns:



37
38
39
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 37

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:



40
41
42
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 40

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/generated/azure_mgmt_sql/sql_management_client.rb', line 15

def base_url
  @base_url
end

#capabilities ⇒ Capabilities (readonly)

Returns capabilities.

Returns:



52
53
54
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 52

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

def credentials
  @credentials
end

#data_masking_policies ⇒ DataMaskingPolicies (readonly)

Returns data_masking_policies.

Returns:



62
63
64
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 62

def data_masking_policies
  @data_masking_policies
end

#data_masking_rules ⇒ DataMaskingRules (readonly)

Returns data_masking_rules.

Returns:



65
66
67
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 65

def data_masking_rules
  @data_masking_rules
end

#database_blob_auditing_policies ⇒ DatabaseBlobAuditingPolicies (readonly)

Returns database_blob_auditing_policies.

Returns:



120
121
122
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 120

def database_blob_auditing_policies
  @database_blob_auditing_policies
end

#database_threat_detection_policies ⇒ DatabaseThreatDetectionPolicies (readonly)

database_threat_detection_policies

Returns:



59
60
61
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 59

def database_threat_detection_policies
  @database_threat_detection_policies
end

#database_usages ⇒ DatabaseUsages (readonly)

Returns database_usages.

Returns:



117
118
119
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 117

def database_usages
  @database_usages
end

#databases ⇒ Databases (readonly)

Returns databases.

Returns:



74
75
76
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 74

def databases
  @databases
end

#elastic_pool_activities ⇒ ElasticPoolActivities (readonly)

Returns elastic_pool_activities.

Returns:



95
96
97
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 95

def elastic_pool_activities
  @elastic_pool_activities
end

#elastic_pool_database_activities ⇒ ElasticPoolDatabaseActivities (readonly)

Returns elastic_pool_database_activities.

Returns:



98
99
100
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 98

def elastic_pool_database_activities
  @elastic_pool_database_activities
end

#elastic_pools ⇒ ElasticPools (readonly)

Returns elastic_pools.

Returns:



77
78
79
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 77

def elastic_pools
  @elastic_pools
end

#encryption_protectors ⇒ EncryptionProtectors (readonly)

Returns encryption_protectors.

Returns:



123
124
125
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 123

def encryption_protectors
  @encryption_protectors
end

#failover_groups ⇒ FailoverGroups (readonly)

Returns failover_groups.

Returns:



126
127
128
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 126

def failover_groups
  @failover_groups
end

#firewall_rules ⇒ FirewallRules (readonly)

Returns firewall_rules.

Returns:



68
69
70
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 68

def firewall_rules
  @firewall_rules
end

#generate_client_request_id ⇒ Boolean

is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    When set to true a unique x-ms-client-request-id value



33
34
35
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 33

def generate_client_request_id
  @generate_client_request_id
end

#geo_backup_policies ⇒ GeoBackupPolicies (readonly)

Returns geo_backup_policies.

Returns:



71
72
73
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 71

def geo_backup_policies
  @geo_backup_policies
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.

Returns:

  • (Integer) —

    Gets or sets the retry timeout in seconds for Long



29
30
31
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 29

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



129
130
131
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 129

def operations
  @operations
end

#recommended_elastic_pools ⇒ RecommendedElasticPools (readonly)

Returns recommended_elastic_pools.

Returns:



101
102
103
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 101

def recommended_elastic_pools
  @recommended_elastic_pools
end

#recoverable_databases ⇒ RecoverableDatabases (readonly)

Returns recoverable_databases.

Returns:



46
47
48
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 46

def recoverable_databases
  @recoverable_databases
end

#replication_links ⇒ ReplicationLinks (readonly)

Returns replication_links.

Returns:



80
81
82
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 80

def replication_links
  @replication_links
end

#restorable_dropped_databases ⇒ RestorableDroppedDatabases (readonly)

Returns restorable_dropped_databases.

Returns:



49
50
51
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 49

def restorable_dropped_databases
  @restorable_dropped_databases
end

#restore_points ⇒ RestorePoints (readonly)

Returns restore_points.

Returns:



43
44
45
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 43

def restore_points
  @restore_points
end

#server_azure_adadministrators ⇒ ServerAzureADAdministrators (readonly)

Returns server_azure_adadministrators.

Returns:



83
84
85
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 83

def server_azure_adadministrators
  @server_azure_adadministrators
end

#server_communication_links ⇒ ServerCommunicationLinks (readonly)

Returns server_communication_links.

Returns:



86
87
88
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 86

def server_communication_links
  @server_communication_links
end

#server_connection_policies ⇒ ServerConnectionPolicies (readonly)

Returns server_connection_policies.

Returns:



55
56
57
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 55

def server_connection_policies
  @server_connection_policies
end

#server_keys ⇒ ServerKeys (readonly)

Returns server_keys.

Returns:



132
133
134
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 132

def server_keys
  @server_keys
end

#server_usages ⇒ ServerUsages (readonly)

Returns server_usages.

Returns:



114
115
116
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 114

def server_usages
  @server_usages
end

#servers ⇒ Servers (readonly)

Returns servers.

Returns:



92
93
94
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 92

def servers
  @servers
end

#service_objectives ⇒ ServiceObjectives (readonly)

Returns service_objectives.

Returns:



89
90
91
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 89

def service_objectives
  @service_objectives
end

#service_tier_advisors ⇒ ServiceTierAdvisors (readonly)

Returns service_tier_advisors.

Returns:



104
105
106
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 104

def service_tier_advisors
  @service_tier_advisors
end

#subscription_id ⇒ String

subscription.

Returns:

  • (String) —

    The subscription ID that identifies an Azure



22
23
24
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 22

def subscription_id
  @subscription_id
end

#sync_agents ⇒ SyncAgents (readonly)

Returns sync_agents.

Returns:



135
136
137
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 135

def sync_agents
  @sync_agents
end

#sync_groups ⇒ SyncGroups (readonly)

Returns sync_groups.

Returns:



138
139
140
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 138

def sync_groups
  @sync_groups
end

#sync_members ⇒ SyncMembers (readonly)

Returns sync_members.

Returns:



141
142
143
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 141

def sync_members
  @sync_members
end

#transparent_data_encryption_activities ⇒ TransparentDataEncryptionActivities (readonly)

transparent_data_encryption_activities

Returns:



111
112
113
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 111

def transparent_data_encryption_activities
  @transparent_data_encryption_activities
end

#transparent_data_encryptions ⇒ TransparentDataEncryptions (readonly)

Returns transparent_data_encryptions.

Returns:



107
108
109
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 107

def transparent_data_encryptions
  @transparent_data_encryptions
end

#virtual_network_rules ⇒ VirtualNetworkRules (readonly)

Returns virtual_network_rules.

Returns:



144
145
146
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 144

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.



217
218
219
220
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 217

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.



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 242

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

  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.



229
230
231
232
233
 
# File 'lib/generated/azure_mgmt_sql/sql_management_client.rb', line 229

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